Interface IAsyncContextDefinition<T>

Definition contract for creating an async context.

This is the object form consumed by defineAsyncContext(...).

interface IAsyncContextDefinition<T> {
    configSchema?: ValidationSchemaInput<T>;
    id: string;
    meta?: IAsyncContextMeta;
    parse?(data: string): T;
    serialize?(data: T): string;
}

Type Parameters

T

Index

Properties

configSchema? id meta?

Methods

parse? serialize?

Properties

`Optional`configSchema

configSchema?: ValidationSchemaInput<T>

When provided, context values will be validated when provide() is called.

id

id: string

Stable context id used for registration, lookup, and serialization envelopes.

`Optional`meta

meta?: IAsyncContextMeta

Optional metadata used by docs and tooling.

Methods

`Optional`parse

parse?(data: string): T
Custom parser paired with serialize.
Parameters
- data: string
Returns T
- Defined in src/types/asyncContext.ts:27

`Optional`serialize

serialize?(data: T): string
Custom serializer for transporting the context across process or network boundaries.
Parameters
- data: T
Returns string
- Defined in src/types/asyncContext.ts:23