Interface IAsyncContext<T>

The generic AsyncContext object returned by defineAsyncContext.

interface IAsyncContext<T> {
    "[symbolAsyncContext]": true;
    "[symbolFilePath]": string;
    id: string;
    optional(): IOptionalDependency<IAsyncContext<T>>;
    parse(data: string): T;
    provide<R>(value: T, fn: () => R | Promise<R>): R | Promise<R>;
    require(): ITaskMiddlewareConfigured<{ context: IAsyncContext<T> }>;
    serialize(data: T): string;
    use(): T;
}

Type Parameters

T

Index

Properties

[symbolAsyncContext] [symbolFilePath] id

Methods

optional parse provide require serialize use

Properties

[symbolAsyncContext]

"[symbolAsyncContext]": true

Brand marker for registration and runtime checks

[symbolFilePath]

"[symbolFilePath]": string

File path where this async context was defined

`Readonly`id

id: string

unique symbol used as key in the AsyncLocalStorage map

Methods

optional

optional(): IOptionalDependency<IAsyncContext<T>>
Return an optional dependency wrapper for this context

Returns IOptionalDependency<IAsyncContext<T>>
- Defined in src/types/asyncContext.ts:39

parse

parse(data: string): T
Parameters
- data: string
Returns T
- Defined in src/types/asyncContext.ts:37

provide

provide<R>(value: T, fn: () => R | Promise<R>): R | Promise<R>
Provide a value for this context during the lifetime of fn()
Type Parameters
- R
Parameters
- value: T
- fn: () => R | Promise<R>
Returns R | Promise<R>
- Defined in src/types/asyncContext.ts:30

require

require(): ITaskMiddlewareConfigured<{ context: IAsyncContext<T> }>
Generates a middleware that guarantees the context exists.

Returns ITaskMiddlewareConfigured<{ context: IAsyncContext<T> }>
- Defined in src/types/asyncContext.ts:34

serialize

serialize(data: T): string
Parameters
- data: T
Returns string
- Defined in src/types/asyncContext.ts:36

use

use(): T
Retrieve the current context value or throw

Returns T
- Defined in src/types/asyncContext.ts:26