Interface Scope

Readonlydisposed

Optional Readonlyparent

Readonlysignal

all

• all<T>(promises: Promise<T>[]): Promise<T[]>

  Run multiple promises under this scope and await all.

  Type Parameters

  • T

  Parameters

  • promises: Promise<T>[]

    Array of promises to await.

  Returns Promise<T[]>

child

• child(opts?: { label?: string }): Scope

  Create a child scope that will be canceled when this scope is.

  Parameters

  • Optionalopts: { label?: string }

    • Optionallabel?: string

      Optional identifier for diagnostics.

  Returns Scope

dispose

• dispose(reason?: DisposeReason): void

  Dispose this scope and all children.

  Parameters

  • Optionalreason: DisposeReason

    Optional reason for disposal.

  Returns void

fetch

• fetch(input: RequestInfo | URL, init?: RequestInit): Promise<Response>

  Like fetch, but automatically merges this scope’s signal with user-supplied ones.

  Parameters

  • input: RequestInfo | URL

    Request input.
  • Optionalinit: RequestInit

    Optional fetch init opts.

  Returns Promise<Response>

onDispose

• onDispose(fn: () => void): void

  Register a callback to run when the scope is disposed.

  Parameters

  • fn: () => void

  Returns void

race

• race<T>(promises: Promise<T>[]): Promise<T>

  Run a promise race under this scope.

  Type Parameters

  • T

  Parameters

  • promises: Promise<T>[]

    Array of promises to race.

  Returns Promise<T>

run

• run<T>(fn: (s: Scope) => T | Promise<T>): Promise<T>

  Run a callback within this scope. Disposes if cancellation occurs.

  Type Parameters

  • T

  Parameters

  • fn: (s: Scope) => T | Promise<T>

    Function that receives the current scope.

  Returns Promise<T>

timeout

• timeout(ms: number, reason?: string): AbortSignal

  Returns a signal that aborts after the given timeout or when the scope aborts.

  Parameters

  • ms: number

    Timeout duration in milliseconds.
  • Optionalreason: string

    Optional reason for the timeout.

  Returns AbortSignal