diff --git a/packages/effect-fc/src/Lens.ts b/packages/effect-fc/src/Lens.ts index 54dd93a..f755595 100644 --- a/packages/effect-fc/src/Lens.ts +++ b/packages/effect-fc/src/Lens.ts @@ -6,7 +6,11 @@ export const LensTypeId: unique symbol = Symbol.for("@effect-fc/Lens/Lens") export type LensTypeId = typeof LensTypeId /** - * Read/write view over a value that exposes the latest value and a stream of updates. + * A bidirectional view into some shared state that exposes: + * + * 1. a `get` effect for reading the current value of type `A`, + * 2. a `changes` stream that emits every subsequent update to `A`, and + * 3. a `modify` effect that can transform the current value. */ export interface Lens extends Subscribable.Subscribable {