CodeVetter · Repo Unpack · Feature catalog
immerjs/immer
The user-facing surface is primarily a library API for creating and examining immutable updates. Recipes support direct and curried calls, explicit replacement, manual draft lifecycles, and optional reversible patches. Collection support, class draftability, type helpers, configurable copying, and array interception extend that surface, while the website explains their usage.
- produce accepts a base value and recipe, validates callback arguments, drafts eligible objects, handles primitive inputs directly, and returns either the resulting state or a replacement.
- Curried produce captures a recipe and optional default base, then forwards later arguments and the caller's this context into recipe.call.
- enablePatches activates produce listeners, produceWithPatches tuples, and applyPatches replay; Patch exposes add, remove, and replace operations with array-valued paths.
- createDraft opens a mutable draft without a recipe callback, and finishDraft finalizes only drafts marked manual, optionally reporting patches.
- enableMapSet supplies DraftMap and DraftSet implementations with mutation methods, iteration, nested value drafting, and revocation checks.
- enableArrayMethods intercepts seven mutating methods and selected read methods; filter, slice, find, and findLast return selected drafts, while concat and flat return base elements.
- isDraft, isDraftable, original, and current inspect draft state; immerable marks custom instances or constructors as draftable, and nothing requests an undefined replacement.
- Configuration APIs control auto-freezing, strict shallow copying, and strict iteration; Draft and Immutable recursively map types, while castDraft and castImmutable are runtime identity casts.