API Reference

Complete API documentation for Craft.

Core Functions

The main functions for creating and managing immutable state updates.

• craft() - Create immutable state updates
• createDraft() - Create a draft manually
• finishDraft() - Finalize a draft
• nothing - Delete properties or array elements

Composition

Utilities for composing and chaining state updates.

• crafted() - Create curried updater functions
• compose() - Combine multiple producers
• pipe() - Apply producers sequentially
• composer() - Fluent composition API

Introspection

Functions for inspecting draft state.

• isDraft() - Check if value is a draft
• current() - Get immutable snapshot
• original() - Get original value

Patches

JSON Patch support (RFC 6902) for tracking state changes.

• craftWithPatches() - Generate patches
• applyPatches() - Apply patches to state

Debugging

Development utilities for debugging draft state.

• inspectDraft() - Inspect draft metadata
• visualizeDraft() - Visualize draft tree
• assertDraft() - Assert draft status
• assertNotDraft() - Assert not draft
• describeDraft() - Human-readable description
• getDraftTreeSummary() - Draft tree summary
• enableDebugMode() - Enable debug mode
• disableDebugMode() - Disable debug mode
• isDebugEnabled() - Check debug status
• getDebugConfig() - Get debug config

Configuration

Functions for configuring Craft's behavior.

• setAutoFreeze() - Control auto-freeze
• setUseStrictShallowCopy() - Strict shallow copy
• setCustomShallowCopy() - Custom cloning logic

Utilities

Helper functions and type utilities.

• freeze() - Manually freeze objects
• castDraft() - Cast to draft type
• castImmutable() - Cast to immutable type

Type Exports

import type {
  Draft,
  Immutable,
  Producer,
  Patch,
  PatchListener,
} from "@sylphx/craft";

Quick Reference

Basic Usage

import { craft } from "@sylphx/craft";

const next = craft(state, draft => {
  draft.value = newValue;
});

Curried Updates

import { crafted } from "@sylphx/craft";

const increment = crafted((draft: State) => {
  draft.count++;
});

const next = increment(state);

Composition

import { compose, pipe } from "@sylphx/craft";

// Combine producers
const next = craft(state, compose(producer1, producer2));

// Sequential application
const next = pipe(state, producer1, producer2);

Patches

import { craftWithPatches, applyPatches } from "@sylphx/craft";

const [next, patches, inversePatches] = craftWithPatches(state, draft => {
  draft.value = newValue;
});

const recreated = applyPatches(state, patches);
const reverted = applyPatches(next, inversePatches);

Introspection

import { isDraft, current, original } from "@sylphx/craft";

craft(state, draft => {
  console.log(isDraft(draft)); // true
  console.log(current(draft)); // immutable snapshot
  console.log(original(draft)); // original value
});

Next Steps

• Core Functions - Main API functions
• Composition - Composition utilities
• Debugging - Debug utilities
• Examples - Real-world examples