Interface ExecutionContextAccessor

Built-in async-context accessor for execution tracing.

interface ExecutionContextAccessor {
    id: "executionContext";
    has(): boolean;
    provide<T>(fn: () => T): T;
    provide<T>(options: ExecutionContextProvideOptions, fn: () => T): T;
    record<T>(fn: () => T): Promise<ExecutionRecordResult<Awaited<T>>>;
    record<T>(
        options: ExecutionContextProvideOptions,
        fn: () => T,
    ): Promise<ExecutionRecordResult<Awaited<T>>>;
    tryUse(): ExecutionContextSnapshot | undefined;
    use(): ExecutionContextSnapshot;
}

Index

Properties

Methods

has provide record tryUse use

Properties

`Readonly`id

id: "executionContext"

Stable id of the built-in execution async context.

Methods

has

has(): boolean
Reports whether an execution snapshot is currently active.

Returns boolean
- Defined in src/types/executionContext.ts:178

provide

provide<T>(fn: () => T): T
Runs a callback inside an execution context using default options.
Type Parameters
- T
Parameters
- fn: () => T
Returns T
- Defined in src/types/executionContext.ts:180
provide<T>(options: ExecutionContextProvideOptions, fn: () => T): T
Runs a callback inside an execution context with explicit options.
Type Parameters
- T
Parameters
- options: ExecutionContextProvideOptions
- fn: () => T
Returns T
- Defined in src/types/executionContext.ts:182

record

record<T>(fn: () => T): Promise<ExecutionRecordResult<Awaited<T>>>
Records an execution tree using default options.
Type Parameters
- T
Parameters
- fn: () => T
Returns Promise<ExecutionRecordResult<Awaited<T>>>
- Defined in src/types/executionContext.ts:184
record<T>(
options: ExecutionContextProvideOptions,
fn: () => T,
): Promise<ExecutionRecordResult<Awaited<T>>>
Records an execution tree with explicit options.
Type Parameters
- T
Parameters
- options: ExecutionContextProvideOptions
- fn: () => T
Returns Promise<ExecutionRecordResult<Awaited<T>>>
- Defined in src/types/executionContext.ts:186

tryUse

tryUse(): ExecutionContextSnapshot | undefined
Returns the current execution snapshot when available.

Returns ExecutionContextSnapshot | undefined
- Defined in src/types/executionContext.ts:176

use

use(): ExecutionContextSnapshot
Returns the current execution snapshot or throws when unavailable.

Returns ExecutionContextSnapshot
- Defined in src/types/executionContext.ts:174