API / types
Generated API reference for @gentleduck/error, listing every export, type, and signature, straight from source.
Everything under generated/ on this page is produced from packages/duck-error/src with
TypeDoc (typedoc-plugin-markdown), not hand-written. Regenerate it with:
bun run docs:api
run from apps/duck-error-docs, or bun run --cwd apps/duck-error-docs docs:api from the repo
root. It reads the same JSDoc comments the editor shows you on hover; if a description here is
wrong or missing, the fix belongs in packages/duck-error/src, not in these files. This page
itself (api/index.mdx) is hand-written and lives outside generated/ on purpose, so a clean
regeneration never touches it.
For the narrative version of this same surface, grouped by task, with the reasoning behind each piece, see the hand-written API reference instead.
Contents
- Full index: every export in one page
- Functions:
createErrorKit,detail,fault,isSecretKey,scrubMeta - Interfaces:
ErrorKit,KitError - Namespaces:
Brand,ErrorKit