From 8fb997a2a0d0b9d4e65a1055cf25ce2cd1dc1371 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Julien=20Valverd=C3=A9?= Date: Tue, 24 Mar 2026 12:19:22 +0100 Subject: [PATCH] Update docs --- packages/effect-fc/src/Lens.ts | 21 ++++++++++++--------- 1 file changed, 12 insertions(+), 9 deletions(-) diff --git a/packages/effect-fc/src/Lens.ts b/packages/effect-fc/src/Lens.ts index 4de43dd..be02ae7 100644 --- a/packages/effect-fc/src/Lens.ts +++ b/packages/effect-fc/src/Lens.ts @@ -298,10 +298,13 @@ export const focusChunkAt: { /** - * Reads the current value from the Lens. + * Reads the current value from a `Lens`. */ export const get = (self: Lens): Effect.Effect => self.get +/** + * Sets the value of a `Lens`. + */ export const set: { (value: A): (self: Lens) => Effect.Effect (self: Lens, value: A): Effect.Effect @@ -310,7 +313,7 @@ export const set: { ) /** - * Sets the `Lens` to a new value and returns the previous value. + * Sets a `Lens` to a new value and returns the previous value. */ export const getAndSet: { (value: A): (self: Lens) => Effect.Effect @@ -320,7 +323,7 @@ export const getAndSet: { ) /** - * Applies a synchronous transformation to the focused value, discarding the previous value. + * Applies a synchronous transformation to the value of a `Lens`, discarding the previous value. */ export const update: { (f: (a: A) => A): (self: Lens) => Effect.Effect @@ -330,7 +333,7 @@ export const update: { ) /** - * Applies an effectful transformation to the focused value, discarding the previous value. + * Applies an effectful transformation to the value of a `Lens`, discarding the previous value. */ export const updateEffect: { (f: (a: A) => Effect.Effect): (self: Lens) => Effect.Effect @@ -343,7 +346,7 @@ export const updateEffect: { ) /** - * Applies a synchronous transformation while returning the previous value. + * Applies a synchronous transformation the value of a `Lens` while returning the previous value. */ export const getAndUpdate: { (f: (a: A) => A): (self: Lens) => Effect.Effect @@ -353,7 +356,7 @@ export const getAndUpdate: { ) /** - * Applies an effectful transformation while returning the previous value. + * Applies an effectful transformation the value of a `Lens` while returning the previous value. */ export const getAndUpdateEffect: { (f: (a: A) => Effect.Effect): (self: Lens) => Effect.Effect @@ -366,7 +369,7 @@ export const getAndUpdateEffect: { ) /** - * Sets the value and returns the new value. + * Sets the value of a `Lens` and returns the new value. */ export const setAndGet: { (value: A): (self: Lens) => Effect.Effect @@ -376,7 +379,7 @@ export const setAndGet: { ) /** - * Applies a synchronous update and returns the new value. + * Applies a synchronous update the value of a `Lens` and returns the new value. */ export const updateAndGet: { (f: (a: A) => A): (self: Lens) => Effect.Effect @@ -389,7 +392,7 @@ export const updateAndGet: { ) /** - * Applies an effectful update and returns the new value. + * Applies an effectful update to the value of a `Lens` and returns the new value. */ export const updateAndGetEffect: { (f: (a: A) => Effect.Effect): (self: Lens) => Effect.Effect