@async/json

@async/json API Surface Ledger

This file is the generated review ledger for semantic API contract features. It is current-state contract documentation, not a changelog or tutorial.

Async JSON Package Exports

Contract: @async/json.package

Exports

FeatureTitleReleaseStabilityLifecycleReplacementDocs
export.redis@async/json/redis provides an optional Redis JSON store adapterbetapreviewactivedocs
export.root@async/json opens JSON file/folder databases and exports stable JSON and file helperspublicstableactivedocs

Async JSON Runtime

Contract: @async/json.runtime

Runtime

FeatureTitleReleaseStabilityLifecycleReplacementDocs
runtime.append-onlyAppend-only collections allow append writes and block create, update, delete, and replace-all mutationspublicstableactivedocs
runtime.encoded-payloadsBytes field metadata validates base64, base64url, and hex JSON-safe payload stringspublicstableactivedocs
runtime.file-folderJSON file and folder paths open as collection/document resources with sidecar state by defaultpublicstableactivedocs
runtime.file-helpersFile helper namespace patches JSON files atomically while preserving existing object key orderpublicstableactivedocs
runtime.identityCollections support scalar idField identity and compound object-key identity without encoded fake idspublicstableactivedocs
runtime.local-engineLocal JSON engine owns atomic writes, sidecar state, version history, recovery, advisory locks, and declared indexespublicstableactivedocs
runtime.queryCollection query helpers support where, orderBy, limit, offset, count, and aggregatepublicstableactivedocs
runtime.redis-jsonRedis JSON adapter stores collection records under per-record canonical identity keys and creates only declared search indexesbetapreviewactivedocs
runtime.resource-proxyFolder database handles expose resources as properties with callable control collision handlingpublicstableactivedocs
runtime.stable-jsonStable JSON helpers provide deterministic stringify, JSON5-compatible parse, ref-aware revivers, and an opt-in JSON shimpublicstableactivedocs

Supported Surfaces

ContractHashFeatures
@async/json.packagesha256:fadc5b04de3d99e776b4b373420cf7e28eecf725ac4d848098cb3462f3820161export.redis, export.root
@async/json.runtimesha256:eda18939522d0122fdd75a89308343e64e16d49b9c271fc080e8f3e13c2b5d22runtime.append-only, runtime.encoded-payloads, runtime.file-folder, runtime.file-helpers, runtime.identity, runtime.local-engine, runtime.query, runtime.redis-json, runtime.resource-proxy, runtime.stable-json