diff --git a/packages/effect-lens/README.md b/packages/effect-lens/README.md index b8d1426..27eb130 100644 --- a/packages/effect-lens/README.md +++ b/packages/effect-lens/README.md @@ -151,3 +151,12 @@ yield* Lens.set( ``` Currently available: +| Name | Description | Parent state mutation behavior | Notes | +| - | - | - | - | +| `Lens.focusField` | Focuses to the field of an object. Replaces the parent object immutably when writing to the focused field | Immutable | | +| `Lens.focusMutableField` | Focuses to the field of an object. Mutates the parent object in place via the writable field | Mutable | Type-safe: will not allow you to mutate `readonly` fields | +| `Lens.focusArrayAt` | Focuses to an indexed entry of an array. Replaces the parent array immutably when writing to the focused index | Immutable | | +| `Lens.focusMutableArrayAt` | Focuses to an indexed entry of an array. Mutates the parent array in place at the focused index | Mutable | Type-safe: will not allow you to mutate `readonly` arrays | +| `Lens.focusChunkAt` | Focuses to an indexed entry of a `Chunk`. Replaces the parent `Chunk` immutably when writing to the focused element | Immutable | | + +Also more to come!