Optic17

Constructors

fromChecksfunctionCreates a Prism from one or more Schema validation checks.makeIsofunctionCreates an Iso from a pair of conversion functions.makeLensfunctionCreates a Lens from a getter and a replacer.makeOptionalfunctionCreates an Optional from a fallible getter and a fallible setter.makePrismfunctionCreates a Prism from a fallible getter and an infallible setter.

Iso

entriesfunctionIso that converts a Record<string, A> to an array of [key, value] entries and back.idfunctionIso that focuses on the whole value unchanged.IsointerfaceA lossless, reversible conversion between types S and A.

Lens

LensinterfaceFocuses on exactly one part A inside a whole S.

Optional

OptionalinterfaceThe most general optic — both reading and writing can fail.

Prism

failurefunctionPrism that focuses on the failure value of a Result.nonefunctionPrism that focuses on Option.None, exposing undefined.PrisminterfaceFocuses on a part A of S that may not be present (e.g.somefunctionPrism that focuses on the value inside Option.Some.successfunctionPrism that focuses on the success value of a Result.

Traversal

getAllfunctionReturns a function that extracts all elements focused by a Traversal as a plain mutable array.TraversalinterfaceAn optic that focuses on zero or more elements of type A inside S.