npm - unthrown - Versions diffs - 3.0.0 → 3.1.0 - Mend

unthrown 3.0.0 → 3.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (10) hide show

package/docs/index.md DELETED Viewed

@@ -1,1407 +0,0 @@
-**unthrown**
-***
-# unthrown
-## Classes
-### UnwrapError
-Defined in: [packages/core/src/core.ts:35](https://github.com/btravstack/unthrown/blob/544e3bf9c78133de7b31b82a17110bf70ee814fb/packages/core/src/core.ts#L35)
-Thrown by a [Result](#result)'s `unwrap` / `unwrapErr` when the assertion is
-wrong on a *modeled* result — `unwrap()` on an `Err`, or `unwrapErr()` on an
-`Ok`.
-#### Remarks
-The offending value is exposed two ways: the typed [UnwrapError.error](#error)
-property for programmatic access, and the standard `Error.cause` for the
-runtime and devtools to chain — when `E` is an `Error` (e.g. a `TaggedError`)
-its original stack is printed under "caused by".
-A `Defect` is never wrapped in an `UnwrapError`: its original cause is
-re-thrown (with its original stack) instead.
-#### Extends
-- `Error`
-#### Type Parameters
-| Type Parameter | Default type | Description |
-| ------ | ------ | ------ |
-| `E` | `unknown` | the type of the [UnwrapError.error](#error) it carries. |
-#### Constructors
-##### Constructor
-```ts
-new UnwrapError<E>(error): UnwrapError<E>;
-```
-Defined in: [packages/core/src/core.ts:41](https://github.com/btravstack/unthrown/blob/544e3bf9c78133de7b31b82a17110bf70ee814fb/packages/core/src/core.ts#L41)
-###### Parameters
-| Parameter | Type |
-| ------ | ------ |
-| `error` | `E` |
-###### Returns
-[`UnwrapError`](#unwraperror)&lt;`E`&gt;
-###### Overrides
-```ts
-Error.constructor
-```
-#### Properties
-| Property | Modifier | Type | Description | Inherited from | Defined in |
-| ------ | ------ | ------ | ------ | ------ | ------ |
-| <a id="cause"></a> `cause?` | `public` | `unknown` | - | `Error.cause` | node\_modules/.pnpm/typescript@6.0.3/node\_modules/typescript/lib/lib.es2022.error.d.ts:24 |
-| <a id="error"></a> `error` | `readonly` | `E` | The offending value: the `Err` error for `unwrap()`, or the `Ok` value for `unwrapErr()`. | - | [packages/core/src/core.ts:40](https://github.com/btravstack/unthrown/blob/544e3bf9c78133de7b31b82a17110bf70ee814fb/packages/core/src/core.ts#L40) |
-| <a id="message"></a> `message` | `public` | `string` | - | `Error.message` | node\_modules/.pnpm/typescript@6.0.3/node\_modules/typescript/lib/lib.es5.d.ts:1075 |
-| <a id="name"></a> `name` | `public` | `string` | - | `Error.name` | node\_modules/.pnpm/typescript@6.0.3/node\_modules/typescript/lib/lib.es5.d.ts:1074 |
-| <a id="stack"></a> `stack?` | `public` | `string` | - | `Error.stack` | node\_modules/.pnpm/typescript@6.0.3/node\_modules/typescript/lib/lib.es5.d.ts:1076 |
-| <a id="stacktracelimit"></a> `stackTraceLimit` | `static` | `number` | The `Error.stackTraceLimit` property specifies the number of stack frames collected by a stack trace (whether generated by `new Error().stack` or `Error.captureStackTrace(obj)`). The default value is `10` but may be set to any valid JavaScript number. Changes will affect any stack trace captured _after_ the value has been changed. If set to a non-number value, or set to a negative number, stack traces will not capture any frames. | `Error.stackTraceLimit` | node\_modules/.pnpm/@types+node@24.13.2/node\_modules/@types/node/globals.d.ts:68 |
-#### Methods
-##### captureStackTrace()
-```ts
-static captureStackTrace(targetObject, constructorOpt?): void;
-```
-Defined in: node\_modules/.pnpm/@types+node@24.13.2/node\_modules/@types/node/globals.d.ts:52
-Creates a `.stack` property on `targetObject`, which when accessed returns
-a string representing the location in the code at which
-`Error.captureStackTrace()` was called.
-```js
-const myObject = {};
-Error.captureStackTrace(myObject);
-myObject.stack;  // Similar to `new Error().stack`
-```
-The first line of the trace will be prefixed with
-`${myObject.name}: ${myObject.message}`.
-The optional `constructorOpt` argument accepts a function. If given, all frames
-above `constructorOpt`, including `constructorOpt`, will be omitted from the
-generated stack trace.
-The `constructorOpt` argument is useful for hiding implementation
-details of error generation from the user. For instance:
-```js
-function a() {
-  b();
-}
-function b() {
-  c();
-}
-function c() {
-  // Create an error without stack trace to avoid calculating the stack trace twice.
-  const { stackTraceLimit } = Error;
-  Error.stackTraceLimit = 0;
-  const error = new Error();
-  Error.stackTraceLimit = stackTraceLimit;
-  // Capture the stack trace above function b
-  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
-  throw error;
-}
-a();
-```
-###### Parameters
-| Parameter | Type |
-| ------ | ------ |
-| `targetObject` | `object` |
-| `constructorOpt?` | `Function` |
-###### Returns
-`void`
-###### Inherited from
-```ts
-Error.captureStackTrace
-```
-##### prepareStackTrace()
-```ts
-static prepareStackTrace(err, stackTraces): any;
-```
-Defined in: node\_modules/.pnpm/@types+node@24.13.2/node\_modules/@types/node/globals.d.ts:56
-###### Parameters
-| Parameter | Type |
-| ------ | ------ |
-| `err` | `Error` |
-| `stackTraces` | `CallSite`[] |
-###### Returns
-`any`
-###### See
-https://v8.dev/docs/stack-trace-api#customizing-stack-traces
-###### Inherited from
-```ts
-Error.prepareStackTrace
-```
-## Type Aliases
-### AsyncErrOf
-```ts
-type AsyncErrOf<R> = R extends AsyncResult<unknown, infer E> ? E : never;
-```
-Defined in: [packages/core/src/types.ts:468](https://github.com/btravstack/unthrown/blob/544e3bf9c78133de7b31b82a17110bf70ee814fb/packages/core/src/types.ts#L468)
-Extract the error type `E` from an [AsyncResult](#asyncresult).
-#### Type Parameters
-| Type Parameter | Description |
-| ------ | ------ |
-| `R` | the `AsyncResult` type to inspect. |
-***
-### AsyncOkOf
-```ts
-type AsyncOkOf<R> = R extends AsyncResult<infer T, unknown> ? T : never;
-```
-Defined in: [packages/core/src/types.ts:462](https://github.com/btravstack/unthrown/blob/544e3bf9c78133de7b31b82a17110bf70ee814fb/packages/core/src/types.ts#L462)
-Extract the success type `T` from an [AsyncResult](#asyncresult).
-#### Type Parameters
-| Type Parameter | Description |
-| ------ | ------ |
-| `R` | the `AsyncResult` type to inspect. |
-***
-### AsyncResult
-```ts
-type AsyncResult<T, E> = AsyncResultType<T, E>;
-```
-Defined in: [packages/core/src/facade.ts:85](https://github.com/btravstack/unthrown/blob/544e3bf9c78133de7b31b82a17110bf70ee814fb/packages/core/src/facade.ts#L85)
-Companion object grouping the **`AsyncResult`-producing** entry points under
-the matching namespace: [AsyncResult.fromPromise](#property-frompromise),
-[AsyncResult.fromSafePromise](#property-fromsafepromise), [AsyncResult.all](#property-all),
-[AsyncResult.allFromDict](#property-allfromdict).
-#### Type Parameters
-| Type Parameter |
-| ------ |
-| `T` |
-| `E` |
-#### Remarks
-The async sibling of [Result](#result-1). Statics are grouped by what they
-**return**, so `fromPromise`/`fromSafePromise` and the async aggregates sit
-here rather than on [Result](#result-1); the namespace already conveys "async", so
-the aggregates drop the `Async` suffix (`AsyncResult.all` is the free function
-`allAsync`; `AsyncResult.allFromDict` is `allFromDictAsync`). Like
-[Result](#result-1), the free functions remain the primary, tree-shakeable API; the
-value `AsyncResult` and the type [AsyncResult](#asyncresult-1) share one name.
-#### Example
-```ts
-import { AsyncResult } from "unthrown";
-const user = await AsyncResult.fromPromise(fetchUser(id), (c, defect) => defect(c));
-```
-***
-### Awaitable
-```ts
-type Awaitable<T> = object;
-```
-Defined in: [packages/core/src/types.ts:346](https://github.com/btravstack/unthrown/blob/544e3bf9c78133de7b31b82a17110bf70ee814fb/packages/core/src/types.ts#L346)
-A success-only thenable: awaitable, but deliberately **not** a full
-`PromiseLike`.
-#### Remarks
-An [AsyncResult](#asyncresult)'s internal promise never rejects, so `await`-ing one
-always yields a [Result](#result) and never throws — there is no rejection
-channel to model, and none is advertised. At runtime it is still a thenable
-(the only way `await` can collapse it); the narrowing simply keeps it from
-being treated as a raw promise (e.g. dropped into `Promise.all`).
-#### Type Parameters
-| Type Parameter | Description |
-| ------ | ------ |
-| `T` | the value `await` resolves to. |
-#### Methods
-##### then()
-```ts
-then<R>(onfulfilled?): PromiseLike<R>;
-```
-Defined in: [packages/core/src/types.ts:347](https://github.com/btravstack/unthrown/blob/544e3bf9c78133de7b31b82a17110bf70ee814fb/packages/core/src/types.ts#L347)
-###### Type Parameters
-| Type Parameter | Default type |
-| ------ | ------ |
-| `R` | `T` |
-###### Parameters
-| Parameter | Type |
-| ------ | ------ |
-| `onfulfilled?` | ((`value`) => `R` \| `PromiseLike`&lt;`R`&gt;) \| `null` |
-###### Returns
-`PromiseLike`&lt;`R`&gt;
-***
-### DefectView
-```ts
-type DefectView<T, E> = ResultMethods<T, E> & object;
-```
-Defined in: [packages/core/src/types.ts:289](https://github.com/btravstack/unthrown/blob/544e3bf9c78133de7b31b82a17110bf70ee814fb/packages/core/src/types.ts#L289)
-The `Defect` variant of a [Result](#result): an unmodeled failure carrying a `cause`.
-#### Type Declaration
-| Name | Type | Defined in |
-| ------ | ------ | ------ |
-| `cause` | `unknown` | [packages/core/src/types.ts:291](https://github.com/btravstack/unthrown/blob/544e3bf9c78133de7b31b82a17110bf70ee814fb/packages/core/src/types.ts#L291) |
-| `tag` | `"Defect"` | [packages/core/src/types.ts:290](https://github.com/btravstack/unthrown/blob/544e3bf9c78133de7b31b82a17110bf70ee814fb/packages/core/src/types.ts#L290) |
-#### Type Parameters
-| Type Parameter | Default type |
-| ------ | ------ |
-| `T` | `never` |
-| `E` | `never` |
-***
-### ErrOf
-```ts
-type ErrOf<R> = R extends object ? E : never;
-```
-Defined in: [packages/core/src/types.ts:456](https://github.com/btravstack/unthrown/blob/544e3bf9c78133de7b31b82a17110bf70ee814fb/packages/core/src/types.ts#L456)
-Extract the error type `E` from a `Result`.
-#### Type Parameters
-| Type Parameter | Description |
-| ------ | ------ |
-| `R` | the `Result` type to inspect. |
-***
-### ErrView
-```ts
-type ErrView<E, T> = ResultMethods<T, E> & object;
-```
-Defined in: [packages/core/src/types.ts:284](https://github.com/btravstack/unthrown/blob/544e3bf9c78133de7b31b82a17110bf70ee814fb/packages/core/src/types.ts#L284)
-The `Err` variant of a [Result](#result): a modeled failure carrying an `error`.
-#### Type Declaration
-| Name | Type | Defined in |
-| ------ | ------ | ------ |
-| `error` | `E` | [packages/core/src/types.ts:286](https://github.com/btravstack/unthrown/blob/544e3bf9c78133de7b31b82a17110bf70ee814fb/packages/core/src/types.ts#L286) |
-| `tag` | `"Err"` | [packages/core/src/types.ts:285](https://github.com/btravstack/unthrown/blob/544e3bf9c78133de7b31b82a17110bf70ee814fb/packages/core/src/types.ts#L285) |
-#### Type Parameters
-| Type Parameter | Default type |
-| ------ | ------ |
-| `E` | - |
-| `T` | `never` |
-***
-### OkOf
-```ts
-type OkOf<R> = R extends object ? T : never;
-```
-Defined in: [packages/core/src/types.ts:450](https://github.com/btravstack/unthrown/blob/544e3bf9c78133de7b31b82a17110bf70ee814fb/packages/core/src/types.ts#L450)
-Extract the success type `T` from a `Result`.
-#### Type Parameters
-| Type Parameter | Description |
-| ------ | ------ |
-| `R` | the `Result` type to inspect. |
-***
-### OkView
-```ts
-type OkView<T, E> = ResultMethods<T, E> & object;
-```
-Defined in: [packages/core/src/types.ts:279](https://github.com/btravstack/unthrown/blob/544e3bf9c78133de7b31b82a17110bf70ee814fb/packages/core/src/types.ts#L279)
-The `Ok` variant of a [Result](#result): a success carrying a `value`.
-#### Type Declaration
-| Name | Type | Defined in |
-| ------ | ------ | ------ |
-| `tag` | `"Ok"` | [packages/core/src/types.ts:280](https://github.com/btravstack/unthrown/blob/544e3bf9c78133de7b31b82a17110bf70ee814fb/packages/core/src/types.ts#L280) |
-| `value` | `T` | [packages/core/src/types.ts:281](https://github.com/btravstack/unthrown/blob/544e3bf9c78133de7b31b82a17110bf70ee814fb/packages/core/src/types.ts#L281) |
-#### Type Parameters
-| Type Parameter | Default type |
-| ------ | ------ |
-| `T` | - |
-| `E` | `never` |
-***
-### Result
-```ts
-type Result<T, E> = ResultType<T, E>;
-```
-Defined in: [packages/core/src/facade.ts:45](https://github.com/btravstack/unthrown/blob/544e3bf9c78133de7b31b82a17110bf70ee814fb/packages/core/src/facade.ts#L45)
-Companion object grouping the **`Result`-producing** entry points under a
-single, discoverable namespace: [Result.Ok](#property-ok), [Result.Err](#property-err),
-[Result.Do](#property-do), [Result.fromNullable](#property-fromnullable), [Result.fromThrowable](#property-fromthrowable),
-[Result.all](#property-all-1), [Result.allFromDict](#property-allfromdict-1), [Result.isOk](#property-isok),
-[Result.isErr](#property-iserr), [Result.isDefect](#property-isdefect), [Result.isResult](#property-isresult).
-#### Type Parameters
-| Type Parameter |
-| ------ |
-| `T` |
-| `E` |
-#### Remarks
-Purely additive sugar — each member **is** the corresponding free function.
-The free functions remain the primary, tree-shakeable API; importing only
-`{ Ok }` never pulls this object in. The value `Result` and the type
-[Result](#result-1) share one name (the companion-object pattern).
-The **async** entry points live on the sibling [AsyncResult](#asyncresult-1) companion
-(`AsyncResult.fromPromise`, `AsyncResult.all`, …), grouped by what they
-return — a static lives in exactly one namespace.
-#### Example
-```ts
-import { Result } from "unthrown";
-Result.Ok(1).flatMap((n) => Result.Ok(n + 1)).unwrap(); // 2
-```
-***
-### TaggedErrorConstructor
-```ts
-type TaggedErrorConstructor<Tag> = <A>(args) => TaggedErrorInstance<Tag, A>;
-```
-Defined in: [packages/core/src/tagged.ts:28](https://github.com/btravstack/unthrown/blob/544e3bf9c78133de7b31b82a17110bf70ee814fb/packages/core/src/tagged.ts#L28)
-The class constructor returned by [TaggedError](#taggederror). Generic in its payload:
-apply it with an instantiation expression at the `extends` site.
-#### Type Parameters
-| Type Parameter | Description |
-| ------ | ------ |
-| `Tag` *extends* `string` | the string literal discriminant. |
-#### Parameters
-| Parameter | Type |
-| ------ | ------ |
-| `args` | keyof `A` *extends* `never` ? `void` : `A` |
-#### Returns
-[`TaggedErrorInstance`](#taggederrorinstance)&lt;`Tag`, `A`&gt;
-#### Remarks
-When the payload is empty, the constructor takes **no** arguments (the
-`keyof A extends never ? void : A` trick); otherwise it takes the payload.
-***
-### TaggedErrorInstance
-```ts
-type TaggedErrorInstance<Tag, A> = Error & Readonly<A> & object;
-```
-Defined in: [packages/core/src/tagged.ts:15](https://github.com/btravstack/unthrown/blob/544e3bf9c78133de7b31b82a17110bf70ee814fb/packages/core/src/tagged.ts#L15)
-The instance shape produced by a [TaggedError](#taggederror) class: an `Error` plus a
-`_tag` discriminant and the (readonly) payload fields.
-#### Type Declaration
-| Name | Type | Defined in |
-| ------ | ------ | ------ |
-| `_tag` | `Tag` | [packages/core/src/tagged.ts:16](https://github.com/btravstack/unthrown/blob/544e3bf9c78133de7b31b82a17110bf70ee814fb/packages/core/src/tagged.ts#L16) |
-#### Type Parameters
-| Type Parameter | Description |
-| ------ | ------ |
-| `Tag` *extends* `string` | the string literal discriminant. |
-| `A` *extends* `Props` | the payload object type. |
-***
-### TagHandlers
-```ts
-type TagHandlers<T, E, R> = object & { [K in E["_tag"]]: (error: Extract<E, { _tag: K }>) => R };
-```
-Defined in: [packages/core/src/tagged.ts:103](https://github.com/btravstack/unthrown/blob/544e3bf9c78133de7b31b82a17110bf70ee814fb/packages/core/src/tagged.ts#L103)
-The handler object [matchTags](#matchtags) requires: a branch per error tag, plus
-`Ok` and `Defect`. Miss a tag and it will not compile — the exhaustiveness is
-enforced by the type, with no `.exhaustive()` to forget.
-#### Type Declaration
-| Name | Type | Defined in |
-| ------ | ------ | ------ |
-| `Defect()` | (`cause`) => `R` | [packages/core/src/tagged.ts:105](https://github.com/btravstack/unthrown/blob/544e3bf9c78133de7b31b82a17110bf70ee814fb/packages/core/src/tagged.ts#L105) |
-| `Ok()` | (`value`) => `R` | [packages/core/src/tagged.ts:104](https://github.com/btravstack/unthrown/blob/544e3bf9c78133de7b31b82a17110bf70ee814fb/packages/core/src/tagged.ts#L104) |
-#### Type Parameters
-| Type Parameter | Description |
-| ------ | ------ |
-| `T` | the success value type. |
-| `E` *extends* `object` | the tagged error union. |
-| `R` | the folded result type. |
-## Variables
-### AsyncResult
-```ts
-const AsyncResult: object;
-```
-Defined in: [packages/core/src/facade.ts:85](https://github.com/btravstack/unthrown/blob/544e3bf9c78133de7b31b82a17110bf70ee814fb/packages/core/src/facade.ts#L85)
-Companion object grouping the **`AsyncResult`-producing** entry points under
-the matching namespace: [AsyncResult.fromPromise](#property-frompromise),
-[AsyncResult.fromSafePromise](#property-fromsafepromise), [AsyncResult.all](#property-all),
-[AsyncResult.allFromDict](#property-allfromdict).
-#### Type Declaration
-| Name | Type | Default value | Defined in |
-| ------ | ------ | ------ | ------ |
-| <a id="property-all"></a> `all()` | &lt;`Rs`&gt;(`results`) => `AsyncResult`&lt;`AllOk`&lt;`Rs`, \{ \[K in string \| number \| symbol\]: AsyncOkOf\<Rs\[K\]\> \}&gt;, [`AsyncErrOf`](#asyncerrof)&lt;`Rs`\[`number`\]&gt;&gt; | `allAsync` | [packages/core/src/facade.ts:88](https://github.com/btravstack/unthrown/blob/544e3bf9c78133de7b31b82a17110bf70ee814fb/packages/core/src/facade.ts#L88) |
-| <a id="property-allfromdict"></a> `allFromDict()` | &lt;`R`&gt;(`results`) => `AsyncResult`&lt;\{ \[K in string \| number \| symbol\]: AsyncOkOf\<R\[K\]\> \}, [`AsyncErrOf`](#asyncerrof)&lt;`R`\[keyof `R`\]&gt;&gt; | `allFromDictAsync` | [packages/core/src/facade.ts:89](https://github.com/btravstack/unthrown/blob/544e3bf9c78133de7b31b82a17110bf70ee814fb/packages/core/src/facade.ts#L89) |
-| <a id="property-frompromise"></a> `fromPromise()` | &lt;`T`, `R`&gt;(`promise`, `qualify`) => `AsyncResult`&lt;`T`, `Exclude`&lt;`R`, `Defect`&gt;&gt; | - | [packages/core/src/facade.ts:86](https://github.com/btravstack/unthrown/blob/544e3bf9c78133de7b31b82a17110bf70ee814fb/packages/core/src/facade.ts#L86) |
-| <a id="property-fromsafepromise"></a> `fromSafePromise()` | &lt;`T`&gt;(`promise`) => `AsyncResult`&lt;`T`, `never`&gt; | - | [packages/core/src/facade.ts:87](https://github.com/btravstack/unthrown/blob/544e3bf9c78133de7b31b82a17110bf70ee814fb/packages/core/src/facade.ts#L87) |
-#### Remarks
-The async sibling of [Result](#result-1). Statics are grouped by what they
-**return**, so `fromPromise`/`fromSafePromise` and the async aggregates sit
-here rather than on [Result](#result-1); the namespace already conveys "async", so
-the aggregates drop the `Async` suffix (`AsyncResult.all` is the free function
-`allAsync`; `AsyncResult.allFromDict` is `allFromDictAsync`). Like
-[Result](#result-1), the free functions remain the primary, tree-shakeable API; the
-value `AsyncResult` and the type [AsyncResult](#asyncresult-1) share one name.
-#### Example
-```ts
-import { AsyncResult } from "unthrown";
-const user = await AsyncResult.fromPromise(fetchUser(id), (c, defect) => defect(c));
-```
-***
-### Result
-```ts
-const Result: object;
-```
-Defined in: [packages/core/src/facade.ts:45](https://github.com/btravstack/unthrown/blob/544e3bf9c78133de7b31b82a17110bf70ee814fb/packages/core/src/facade.ts#L45)
-Companion object grouping the **`Result`-producing** entry points under a
-single, discoverable namespace: [Result.Ok](#property-ok), [Result.Err](#property-err),
-[Result.Do](#property-do), [Result.fromNullable](#property-fromnullable), [Result.fromThrowable](#property-fromthrowable),
-[Result.all](#property-all-1), [Result.allFromDict](#property-allfromdict-1), [Result.isOk](#property-isok),
-[Result.isErr](#property-iserr), [Result.isDefect](#property-isdefect), [Result.isResult](#property-isresult).
-#### Type Declaration
-| Name | Type | Defined in |
-| ------ | ------ | ------ |
-| <a id="property-all-1"></a> `all()` | &lt;`Rs`&gt;(`results`) => `Result`&lt;`AllOk`&lt;`Rs`, \{ \[K in string \| number \| symbol\]: OkOf\<Rs\[K\]\> \}&gt;, [`ErrOf`](#errof)&lt;`Rs`\[`number`\]&gt;&gt; | [packages/core/src/facade.ts:51](https://github.com/btravstack/unthrown/blob/544e3bf9c78133de7b31b82a17110bf70ee814fb/packages/core/src/facade.ts#L51) |
-| <a id="property-allfromdict-1"></a> `allFromDict()` | &lt;`R`&gt;(`results`) => `Result`&lt;\{ \[K in string \| number \| symbol\]: OkOf\<R\[K\]\> \}, [`ErrOf`](#errof)&lt;`R`\[keyof `R`\]&gt;&gt; | [packages/core/src/facade.ts:52](https://github.com/btravstack/unthrown/blob/544e3bf9c78133de7b31b82a17110bf70ee814fb/packages/core/src/facade.ts#L52) |
-| <a id="property-do"></a> `Do()` | () => `Result`&lt;\{ \}, `never`&gt; | [packages/core/src/facade.ts:48](https://github.com/btravstack/unthrown/blob/544e3bf9c78133de7b31b82a17110bf70ee814fb/packages/core/src/facade.ts#L48) |
-| <a id="property-err"></a> `Err()` | &lt;`E`&gt;(`error`) => `Result`&lt;`never`, `E`&gt; | [packages/core/src/facade.ts:47](https://github.com/btravstack/unthrown/blob/544e3bf9c78133de7b31b82a17110bf70ee814fb/packages/core/src/facade.ts#L47) |
-| <a id="property-fromnullable"></a> `fromNullable()` | &lt;`T`, `E`&gt;(`value`, `onAbsent`) => `Result`&lt;`NonNullable`&lt;`T`&gt;, `E`&gt; | [packages/core/src/facade.ts:49](https://github.com/btravstack/unthrown/blob/544e3bf9c78133de7b31b82a17110bf70ee814fb/packages/core/src/facade.ts#L49) |
-| <a id="property-fromthrowable"></a> `fromThrowable()` | &lt;`A`, `T`, `R`&gt;(`fn`, `qualify`) => (...`args`) => `Result`&lt;`T`, `Exclude`&lt;`R`, `Defect`&gt;&gt; | [packages/core/src/facade.ts:50](https://github.com/btravstack/unthrown/blob/544e3bf9c78133de7b31b82a17110bf70ee814fb/packages/core/src/facade.ts#L50) |
-| <a id="property-isdefect"></a> `isDefect()` | &lt;`T`, `E`&gt;(`r`) => `r is DefectView<T, E>` | [packages/core/src/facade.ts:55](https://github.com/btravstack/unthrown/blob/544e3bf9c78133de7b31b82a17110bf70ee814fb/packages/core/src/facade.ts#L55) |
-| <a id="property-iserr"></a> `isErr()` | &lt;`T`, `E`&gt;(`r`) => `r is ErrView<E, T>` | [packages/core/src/facade.ts:54](https://github.com/btravstack/unthrown/blob/544e3bf9c78133de7b31b82a17110bf70ee814fb/packages/core/src/facade.ts#L54) |
-| <a id="property-isok"></a> `isOk()` | &lt;`T`, `E`&gt;(`r`) => `r is OkView<T, E>` | [packages/core/src/facade.ts:53](https://github.com/btravstack/unthrown/blob/544e3bf9c78133de7b31b82a17110bf70ee814fb/packages/core/src/facade.ts#L53) |
-| <a id="property-isresult"></a> `isResult()` | (`x`) => `x is Result<unknown, unknown>` | [packages/core/src/facade.ts:56](https://github.com/btravstack/unthrown/blob/544e3bf9c78133de7b31b82a17110bf70ee814fb/packages/core/src/facade.ts#L56) |
-| <a id="property-ok"></a> `Ok()` | &lt;`T`&gt;(`value`) => `Result`&lt;`T`, `never`&gt; | [packages/core/src/facade.ts:46](https://github.com/btravstack/unthrown/blob/544e3bf9c78133de7b31b82a17110bf70ee814fb/packages/core/src/facade.ts#L46) |
-#### Remarks
-Purely additive sugar — each member **is** the corresponding free function.
-The free functions remain the primary, tree-shakeable API; importing only
-`{ Ok }` never pulls this object in. The value `Result` and the type
-[Result](#result-1) share one name (the companion-object pattern).
-The **async** entry points live on the sibling [AsyncResult](#asyncresult-1) companion
-(`AsyncResult.fromPromise`, `AsyncResult.all`, …), grouped by what they
-return — a static lives in exactly one namespace.
-#### Example
-```ts
-import { Result } from "unthrown";
-Result.Ok(1).flatMap((n) => Result.Ok(n + 1)).unwrap(); // 2
-```
-## Functions
-### all()
-```ts
-function all<Rs>(results): Result<AllOk<Rs, { [K in string | number | symbol]: OkOf<Rs[K]> }>, ErrOf<Rs[number]>>;
-```
-Defined in: [packages/core/src/interop.ts:252](https://github.com/btravstack/unthrown/blob/544e3bf9c78133de7b31b82a17110bf70ee814fb/packages/core/src/interop.ts#L252)
-Collect a tuple/array of [Result](#result)s into a single `Result` of all their
-success values.
-#### Type Parameters
-| Type Parameter |
-| ------ |
-| `Rs` *extends* readonly `Result`&lt;`unknown`, `unknown`&gt;[] |
-#### Parameters
-| Parameter | Type |
-| ------ | ------ |
-| `results` | readonly \[`Rs`\] |
-#### Returns
-`Result`&lt;`AllOk`&lt;`Rs`, \{ \[K in string \| number \| symbol\]: OkOf\<Rs\[K\]\> \}&gt;, [`ErrOf`](#errof)&lt;`Rs`\[`number`\]&gt;&gt;
-#### Remarks
-Short-circuits on the **first** `Err` (later entries are not inspected for
-their error); any `Defect` present **dominates**, winning even over an earlier
-`Err`. A **fixed tuple** keeps its positional types — `all([Ok(1), Ok("a")])`
-is `Result<[number, string], …>` — while a **dynamic array** `Result<T, E>[]`
-collapses to `Result<T[], E>` with no cast. For a **record** keyed by name,
-use [allFromDict](#allfromdict).
-#### Example
-```ts
-import { all, Ok } from "unthrown";
-all([Ok(1), Ok("a"), Ok(true)]).unwrap(); // [1, "a", true] (typed [number, string, boolean])
-all([Ok(1), Ok(2)] as Result<number, never>[]).unwrap(); // number[]
-```
-***
-### allAsync()
-```ts
-function allAsync<Rs>(results): AsyncResult<AllOk<Rs, { [K in string | number | symbol]: AsyncOkOf<Rs[K]> }>, AsyncErrOf<Rs[number]>>;
-```
-Defined in: [packages/core/src/interop.ts:302](https://github.com/btravstack/unthrown/blob/544e3bf9c78133de7b31b82a17110bf70ee814fb/packages/core/src/interop.ts#L302)
-The asynchronous counterpart of [all](#all): combine a tuple/array of
-[AsyncResult](#asyncresult)s into one `AsyncResult` of all their success values.
-#### Type Parameters
-| Type Parameter |
-| ------ |
-| `Rs` *extends* readonly `AsyncResult`&lt;`unknown`, `unknown`&gt;[] |
-#### Parameters
-| Parameter | Type |
-| ------ | ------ |
-| `results` | readonly \[`Rs`\] |
-#### Returns
-`AsyncResult`&lt;`AllOk`&lt;`Rs`, \{ \[K in string \| number \| symbol\]: AsyncOkOf\<Rs\[K\]\> \}&gt;, [`AsyncErrOf`](#asyncerrof)&lt;`Rs`\[`number`\]&gt;&gt;
-#### Remarks
-The inputs are resolved **concurrently** (order preserved); the resolved
-`Result`s are then folded with the same rules as [all](#all) — first `Err`
-short-circuits, any `Defect` dominates. As ever, the returned `AsyncResult`'s
-internal promise never rejects. For a **record**, use [allFromDictAsync](#allfromdictasync).
-#### Example
-```ts
-import { allAsync, fromSafePromise } from "unthrown";
-await allAsync([fromSafePromise(a()), fromSafePromise(b())]);
-```
-***
-### allFromDict()
-```ts
-function allFromDict<R>(results): Result<{ [K in string | number | symbol]: OkOf<R[K]> }, ErrOf<R[keyof R]>>;
-```
-Defined in: [packages/core/src/interop.ts:277](https://github.com/btravstack/unthrown/blob/544e3bf9c78133de7b31b82a17110bf70ee814fb/packages/core/src/interop.ts#L277)
-Collect a **record** of [Result](#result)s into a single `Result` of a record of
-their success values — `allFromDict({ a: Result<A, E>, b: Result<B, E> })` is
-`Result<{ a: A; b: B }, E>`. The named counterpart of [all](#all), for
-parallel work you'd rather not tuple.
-#### Type Parameters
-| Type Parameter |
-| ------ |
-| `R` *extends* `ResultRecord` |
-#### Parameters
-| Parameter | Type |
-| ------ | ------ |
-| `results` | `R` |
-#### Returns
-`Result`&lt;\{ \[K in string \| number \| symbol\]: OkOf\<R\[K\]\> \}, [`ErrOf`](#errof)&lt;`R`\[keyof `R`\]&gt;&gt;
-#### Remarks
-Same folding rules as [all](#all): first `Err` short-circuits, any `Defect`
-dominates. This is **not** error accumulation.
-#### Example
-```ts
-import { allFromDict, Ok } from "unthrown";
-allFromDict({ id: Ok(1), name: Ok("ada") }).unwrap(); // { id: 1, name: "ada" }
-```
-***
-### allFromDictAsync()
-```ts
-function allFromDictAsync<R>(results): AsyncResult<{ [K in string | number | symbol]: AsyncOkOf<R[K]> }, AsyncErrOf<R[keyof R]>>;
-```
-Defined in: [packages/core/src/interop.ts:330](https://github.com/btravstack/unthrown/blob/544e3bf9c78133de7b31b82a17110bf70ee814fb/packages/core/src/interop.ts#L330)
-The asynchronous counterpart of [allFromDict](#allfromdict): combine a record of
-[AsyncResult](#asyncresult)s into one `AsyncResult` of a record of their values.
-#### Type Parameters
-| Type Parameter |
-| ------ |
-| `R` *extends* `AsyncResultRecord` |
-#### Parameters
-| Parameter | Type |
-| ------ | ------ |
-| `results` | `R` |
-#### Returns
-`AsyncResult`&lt;\{ \[K in string \| number \| symbol\]: AsyncOkOf\<R\[K\]\> \}, [`AsyncErrOf`](#asyncerrof)&lt;`R`\[keyof `R`\]&gt;&gt;
-#### Remarks
-Resolved concurrently (order preserved), folded with the [all](#all) rules,
-and the internal promise never rejects.
-#### Example
-```ts
-import { allFromDictAsync, fromSafePromise } from "unthrown";
-await allFromDictAsync({ a: fromSafePromise(a()), b: fromSafePromise(b()) });
-```
-***
-### Do()
-```ts
-function Do(): Result<{
-}, never>;
-```
-Defined in: [packages/core/src/do.ts:30](https://github.com/btravstack/unthrown/blob/544e3bf9c78133de7b31b82a17110bf70ee814fb/packages/core/src/do.ts#L30)
-Start a do-notation chain with an empty object scope, grown step by step with
-`bind` (for `Result`-returning steps) and `let` (for pure values).
-#### Returns
-`Result`&lt;\{
-\}, `never`&gt;
-#### Remarks
-Capitalised because `do` is a reserved word. Each step receives the scope
-accumulated so far; the error types union across `bind`s, and a throw in any
-step becomes a `Defect`. To go asynchronous, lift the chain with `toAsync()`
-(then a `bind` may return an `AsyncResult`).
-#### Example
-```ts
-import { Do, Ok } from "unthrown";
-const result = Do()
-  .bind("user", () => findUser(id)) // Result<User, NotFound>
-  .bind("org", ({ user }) => findOrg(user.orgId)) // Result<Org, NotFound>
-  .let("label", ({ user, org }) => `${user.name} @ ${org.name}`)
-  .map(({ user, org, label }) => render(user, org, label));
-// Result<View, NotFound>
-```
-***
-### Err()
-```ts
-function Err<E>(error): Result<never, E>;
-```
-Defined in: [packages/core/src/constructors.ts:34](https://github.com/btravstack/unthrown/blob/544e3bf9c78133de7b31b82a17110bf70ee814fb/packages/core/src/constructors.ts#L34)
-Construct a failed [Result](#result) carrying a **modeled** error.
-#### Type Parameters
-| Type Parameter | Description |
-| ------ | ------ |
-| `E` | the modeled error type. |
-#### Parameters
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `error` | `E` | the domain error to wrap. |
-#### Returns
-`Result`&lt;`never`, `E`&gt;
-#### Example
-```ts
-import { Err } from "unthrown";
-Err("not_found").unwrapErr(); // "not_found"
-```
-***
-### fromNullable()
-```ts
-function fromNullable<T, E>(value, onAbsent): Result<NonNullable<T>, E>;
-```
-Defined in: [packages/core/src/interop.ts:29](https://github.com/btravstack/unthrown/blob/544e3bf9c78133de7b31b82a17110bf70ee814fb/packages/core/src/interop.ts#L29)
-Bridge a nullable value into a [Result](#result): absence becomes a **modeled**
-`Err`. The sanctioned alternative to an `Option` type.
-#### Type Parameters
-| Type Parameter | Description |
-| ------ | ------ |
-| `T` | the (nullable) value type. |
-| `E` | the error produced when the value is absent. |
-#### Parameters
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `value` | `T` \| `null` \| `undefined` | the possibly-absent value. |
-| `onAbsent` | () => `E` | lazily produces the error for the absent case. |
-#### Returns
-`Result`&lt;`NonNullable`&lt;`T`&gt;, `E`&gt;
-#### Remarks
-`null` and `undefined` map to `Err(onAbsent())`; any other value (including
-falsy ones like `0`, `""`, `false`) maps to `Ok`.
-#### Example
-```ts
-import { fromNullable } from "unthrown";
-fromNullable(map.get(key), () => "missing").unwrap();
-```
-***
-### fromPromise()
-```ts
-function fromPromise<T, R>(promise, qualify): AsyncResult<T, Exclude<R, Defect>>;
-```
-Defined in: [packages/core/src/interop.ts:113](https://github.com/btravstack/unthrown/blob/544e3bf9c78133de7b31b82a17110bf70ee814fb/packages/core/src/interop.ts#L113)
-Wrap a `Promise` (or a thunk producing one) as an [AsyncResult](#asyncresult), forcing
-every rejection to be triaged.
-#### Type Parameters
-| Type Parameter | Description |
-| ------ | ------ |
-| `T` | the resolved value type. |
-| `R` | `qualify`'s return type; the modeled error `E` is `Exclude<R, Defect>` (its `Defect` arm, if any, is subtracted). |
-#### Parameters
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `promise` | `Promise`&lt;`T`&gt; \| (() => `Promise`&lt;`T`&gt;) | the promise, or a thunk returning one. |
-| `qualify` | (`cause`, `defect`) => `R` | triages a rejection `cause` into a modeled `E`, or marks it unmodeled by returning `defect(cause)` (the helper passed as its second arg). |
-#### Returns
-`AsyncResult`&lt;`T`, `Exclude`&lt;`R`, `Defect`&gt;&gt;
-#### Remarks
-`qualify` **must** map each rejection cause into a modeled error `E` or a
-`Defect` (via the injected `defect` helper, its second argument). The returned
-`AsyncResult`'s internal promise never rejects; `await`-ing it always yields a
-`Result`. A throw inside `qualify` is itself a `Defect`.
-The modeled error type is `Exclude<R, Defect>` — the `Defect` arm of
-`qualify`'s return is **subtracted** from `E`, never inferred into it. So a
-`qualify` that returns *only* `defect(cause)` yields `E = never`; when every
-rejection is a Defect, prefer [fromSafePromise](#fromsafepromise).
-#### Example
-```ts
-import { fromPromise } from "unthrown";
-const user = await fromPromise(fetchUser(id), (cause, defect) =>
-  cause instanceof NotFoundError ? ("not_found" as const) : defect(cause),
-);
-```
-***
-### fromSafePromise()
-```ts
-function fromSafePromise<T>(promise): AsyncResult<T, never>;
-```
-Defined in: [packages/core/src/interop.ts:139](https://github.com/btravstack/unthrown/blob/544e3bf9c78133de7b31b82a17110bf70ee814fb/packages/core/src/interop.ts#L139)
-Wrap a `Promise` asserted **not** to fail in any modeled way: any rejection
-becomes a `Defect`.
-#### Type Parameters
-| Type Parameter | Description |
-| ------ | ------ |
-| `T` | the resolved value type. |
-#### Parameters
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `promise` | `Promise`&lt;`T`&gt; \| (() => `Promise`&lt;`T`&gt;) | the promise, or a thunk returning one. |
-#### Returns
-`AsyncResult`&lt;`T`, `never`&gt;
-#### Remarks
-Use this only when a rejection genuinely indicates a bug rather than an
-anticipated outcome — the error channel is `never`, so there is nothing to
-triage. (`await`-ing still yields a `Result`; it never throws.)
-***
-### fromThrowable()
-```ts
-function fromThrowable<A, T, R>(fn, qualify): (...args) => Result<T, Exclude<R, Defect>>;
-```
-Defined in: [packages/core/src/interop.ts:68](https://github.com/btravstack/unthrown/blob/544e3bf9c78133de7b31b82a17110bf70ee814fb/packages/core/src/interop.ts#L68)
-Wrap a throwing synchronous function so it returns a [Result](#result) instead of
-throwing.
-#### Type Parameters
-| Type Parameter | Description |
-| ------ | ------ |
-| `A` *extends* `unknown`[] | the wrapped function's argument tuple. |
-| `T` | the wrapped function's return type. |
-| `R` | `qualify`'s return type; the modeled error `E` is `Exclude<R, Defect>` (its `Defect` arm, if any, is subtracted). |
-#### Parameters
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `fn` | (...`args`) => `T` | the throwing function to wrap. |
-| `qualify` | (`cause`, `defect`) => `R` | triages a thrown `cause` into a modeled `E`, or marks it unmodeled by returning `defect(cause)` (the helper passed as its second arg). |
-#### Returns
-a function with the same arguments returning `Result<T, E>`.
-(...`args`) => `Result`&lt;`T`, `Exclude`&lt;`R`, `Defect`&gt;&gt;
-#### Remarks
-`qualify` **must** triage every thrown cause into a modeled error `E` or a
-`Defect` (via the injected `defect` helper, its second argument) — there is no
-path that leaves `unknown` in `E`. A throw inside `qualify` itself is treated
-as a `Defect`.
-The modeled error type is `Exclude<R, Defect>` — the `Defect` arm of
-`qualify`'s return is **subtracted** from `E`, never inferred into it. So a
-`qualify` that returns *only* `defect(cause)` yields `E = never` (a Defect is
-out-of-band and must not pollute the error channel); reach for
-[fromSafePromise](#fromsafepromise) when every failure is a Defect.
-#### Example
-```ts
-import { fromThrowable } from "unthrown";
-const parse = fromThrowable(JSON.parse, (cause, defect) => defect(cause));
-parse("{}").unwrap();
-```
-***
-### isDefect()
-```ts
-function isDefect<T, E>(r): r is DefectView<T, E>;
-```
-Defined in: [packages/core/src/constructors.ts:66](https://github.com/btravstack/unthrown/blob/544e3bf9c78133de7b31b82a17110bf70ee814fb/packages/core/src/constructors.ts#L66)
-Type guard: narrow a [Result](#result) to its `Defect` variant, exposing `.cause`.
-#### Type Parameters
-| Type Parameter |
-| ------ |
-| `T` |
-| `E` |
-#### Parameters
-| Parameter | Type |
-| ------ | ------ |
-| `r` | `Result`&lt;`T`, `E`&gt; |
-#### Returns
-`r is DefectView<T, E>`
-`true` when `r` is a `Defect`.
-***
-### isErr()
-```ts
-function isErr<T, E>(r): r is ErrView<E, T>;
-```
-Defined in: [packages/core/src/constructors.ts:58](https://github.com/btravstack/unthrown/blob/544e3bf9c78133de7b31b82a17110bf70ee814fb/packages/core/src/constructors.ts#L58)
-Type guard: narrow a [Result](#result) to its `Err` variant, exposing `.error`.
-#### Type Parameters
-| Type Parameter |
-| ------ |
-| `T` |
-| `E` |
-#### Parameters
-| Parameter | Type |
-| ------ | ------ |
-| `r` | `Result`&lt;`T`, `E`&gt; |
-#### Returns
-`r is ErrView<E, T>`
-`true` when `r` is `Err`.
-***
-### isOk()
-```ts
-function isOk<T, E>(r): r is OkView<T, E>;
-```
-Defined in: [packages/core/src/constructors.ts:50](https://github.com/btravstack/unthrown/blob/544e3bf9c78133de7b31b82a17110bf70ee814fb/packages/core/src/constructors.ts#L50)
-Type guard: narrow a [Result](#result) to its `Ok` variant, exposing `.value`.
-#### Type Parameters
-| Type Parameter |
-| ------ |
-| `T` |
-| `E` |
-#### Parameters
-| Parameter | Type |
-| ------ | ------ |
-| `r` | `Result`&lt;`T`, `E`&gt; |
-#### Returns
-`r is OkView<T, E>`
-`true` when `r` is `Ok`.
-#### Example
-```ts
-import { isOk, type Result } from "unthrown";
-declare const r: Result<number, string>;
-if (isOk(r)) r.value; // number, narrowed
-```
-***
-### isResult()
-```ts
-function isResult(x): x is Result<unknown, unknown>;
-```
-Defined in: [packages/core/src/core.ts:338](https://github.com/btravstack/unthrown/blob/544e3bf9c78133de7b31b82a17110bf70ee814fb/packages/core/src/core.ts#L338)
-Type guard: is `x` a [Result](#result) (any of `Ok` / `Err` / `Defect`)?
-#### Parameters
-| Parameter | Type |
-| ------ | ------ |
-| `x` | `unknown` |
-#### Returns
-`x is Result<unknown, unknown>`
-`true` when `x` is a `Result` produced by this library.
-#### Remarks
-Unlike [isOk](#isok) / [isErr](#iserr) / [isDefect](#isdefect), which narrow a value
-already known to be a `Result`, this narrows from `unknown` — useful at an
-untyped boundary. It checks the value carries the `Result` prototype, so a
-look-alike plain object (`{ tag: "Ok" }`) is **not** matched. An `AsyncResult`
-is not a `Result` and returns `false`.
-***
-### matchTags()
-#### Call Signature
-```ts
-function matchTags<T, E, R>(result, handlers): R;
-```
-Defined in: [packages/core/src/tagged.ts:138](https://github.com/btravstack/unthrown/blob/544e3bf9c78133de7b31b82a17110bf70ee814fb/packages/core/src/tagged.ts#L138)
-Exhaustively fold a [Result](#result) (or [AsyncResult](#asyncresult)) whose error type is
-a tagged union, dispatching each error to the handler matching its `_tag`.
-##### Type Parameters
-| Type Parameter | Description |
-| ------ | ------ |
-| `T` | the success value type. |
-| `E` *extends* `object` | the tagged error union (`E extends { _tag: string }`). |
-| `R` | the folded result type. |
-##### Parameters
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `result` | `Result`&lt;`T`, `E`&gt; | the result to fold. |
-| `handlers` | [`TagHandlers`](#taghandlers)&lt;`T`, `E`, `R`&gt; | one branch per channel/tag. |
-##### Returns
-`R`
-##### Remarks
-The `handlers` object must provide `Ok`, `Defect`, and exactly one function
-per error tag; each tag's handler receives the narrowed error variant. A
-missing tag is a compile error. For an `AsyncResult`, the fold resolves to a
-`Promise<R>`.
-##### Example
-```ts
-class NotFound extends TaggedError("NotFound") {}
-class Forbidden extends TaggedError("Forbidden")<{ user: string }> {}
-declare const r: Result<number, NotFound | Forbidden>;
-matchTags(r, {
-  Ok: (n) => `got ${n}`,
-  Defect: (cause) => `bug: ${String(cause)}`,
-  NotFound: () => "404",
-  Forbidden: (e) => `403 for ${e.user}`,
-});
-```
-#### Call Signature
-```ts
-function matchTags<T, E, R>(result, handlers): Promise<R>;
-```
-Defined in: [packages/core/src/tagged.ts:142](https://github.com/btravstack/unthrown/blob/544e3bf9c78133de7b31b82a17110bf70ee814fb/packages/core/src/tagged.ts#L142)
-Exhaustively fold a [Result](#result) (or [AsyncResult](#asyncresult)) whose error type is
-a tagged union, dispatching each error to the handler matching its `_tag`.
-##### Type Parameters
-| Type Parameter | Description |
-| ------ | ------ |
-| `T` | the success value type. |
-| `E` *extends* `object` | the tagged error union (`E extends { _tag: string }`). |
-| `R` | the folded result type. |
-##### Parameters
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `result` | `AsyncResult`&lt;`T`, `E`&gt; | the result to fold. |
-| `handlers` | [`TagHandlers`](#taghandlers)&lt;`T`, `E`, `R`&gt; | one branch per channel/tag. |
-##### Returns
-`Promise`&lt;`R`&gt;
-##### Remarks
-The `handlers` object must provide `Ok`, `Defect`, and exactly one function
-per error tag; each tag's handler receives the narrowed error variant. A
-missing tag is a compile error. For an `AsyncResult`, the fold resolves to a
-`Promise<R>`.
-##### Example
-```ts
-class NotFound extends TaggedError("NotFound") {}
-class Forbidden extends TaggedError("Forbidden")<{ user: string }> {}
-declare const r: Result<number, NotFound | Forbidden>;
-matchTags(r, {
-  Ok: (n) => `got ${n}`,
-  Defect: (cause) => `bug: ${String(cause)}`,
-  NotFound: () => "404",
-  Forbidden: (e) => `403 for ${e.user}`,
-});
-```
-***
-### Ok()
-```ts
-function Ok<T>(value): Result<T, never>;
-```
-Defined in: [packages/core/src/constructors.ts:18](https://github.com/btravstack/unthrown/blob/544e3bf9c78133de7b31b82a17110bf70ee814fb/packages/core/src/constructors.ts#L18)
-Construct a successful [Result](#result).
-#### Type Parameters
-| Type Parameter | Description |
-| ------ | ------ |
-| `T` | the success value type. |
-#### Parameters
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `value` | `T` | the success value to wrap. |
-#### Returns
-`Result`&lt;`T`, `never`&gt;
-#### Example
-```ts
-import { Ok } from "unthrown";
-Ok(42).unwrap(); // 42
-```
-***
-### TaggedError()
-```ts
-function TaggedError<Tag>(tag, options?): TaggedErrorConstructor<Tag>;
-```
-Defined in: [packages/core/src/tagged.ts:72](https://github.com/btravstack/unthrown/blob/544e3bf9c78133de7b31b82a17110bf70ee814fb/packages/core/src/tagged.ts#L72)
-Build a base class for a tagged error — a class extending `Error` with a
-`_tag` string discriminant, in the style of Effect's `Data.TaggedError`.
-#### Type Parameters
-| Type Parameter | Description |
-| ------ | ------ |
-| `Tag` *extends* `string` | the string literal discriminant. |
-#### Parameters
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `tag` | `Tag` | the discriminant value; also the default error `name`. |
-| `options?` | \{ `name?`: `string`; \} | optional overrides. `options.name` sets `Error.name` independently of `tag` (defaults to `tag`). |
-| `options.name?` | `string` | - |
-#### Returns
-[`TaggedErrorConstructor`](#taggederrorconstructor)&lt;`Tag`&gt;
-#### Remarks
-Extend the returned class to declare a concrete error. Supply the payload with
-an instantiation expression; omit it for a payload-less error. A `message`
-field in the payload is forwarded to `Error`. The `_tag` always reflects
-`tag` and cannot be overridden by the payload.
-`_tag` is the discriminant used by [matchTags](#matchtags); `Error.name` is the
-human-facing label in stack traces and logs. By default they coincide, but
-they can be **decoupled** with `options.name` — so a tag can be namespaced for
-collision-safety (`"@my-lib/RetryableError"`) without that slash-prefixed
-string leaking into `Error.name`:
-```ts
-class RetryableError extends TaggedError("@my-lib/RetryableError", {
-  name: "RetryableError",
-})<{ message: string }> {}
-const e = new RetryableError({ message: "boom" });
-e._tag; // "@my-lib/RetryableError" — namespaced discriminant
-e.name; // "RetryableError"          — clean display name
-```
-#### Example
-```ts
-class NotFound extends TaggedError("NotFound") {}
-class HttpError extends TaggedError("HttpError")<{ status: number }> {}
-new NotFound()._tag; // "NotFound"
-new HttpError({ status: 500 }).status; // 500
-```