AsyncClientOptions Type — typescript-sdk Architecture

Architecture documentation for the AsyncClientOptions type/interface in async.ts from the typescript-sdk codebase.

Type typescript

Entity Profile

Dependency Diagram

graph TD
  fcd7fcdd_d488_a43a_77e3_2d3e2afef139["AsyncClientOptions"]
  dcc90704_6e64_7ec2_9ee4_aaa5200dbd17["async.ts"]
  fcd7fcdd_d488_a43a_77e3_2d3e2afef139 -->|defined in| dcc90704_6e64_7ec2_9ee4_aaa5200dbd17
  style fcd7fcdd_d488_a43a_77e3_2d3e2afef139 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

src/async.ts lines 38–74

export interface AsyncClientOptions {
  /**
   * Maximum time to wait for a job to complete (in milliseconds).
   * Default: 900000 (15 minutes)
   */
  timeoutMs?: number;

  /**
   * Default retry interval when server doesn't specify (in milliseconds).
   * Default: 10000 (10 seconds)
   */
  defaultRetryIntervalMs?: number;

  /**
   * Maximum number of polling attempts.
   * Default: 90
   */
  maxPollingAttempts?: number;

  /**
   * Callback for polling progress updates.
   * Useful for showing progress indicators in UIs.
   */
  onPollingProgress?: (status: PollingProgress) => void;

  /**
   * Function to generate idempotency keys.
   * Default: crypto.randomUUID() or fallback
   */
  generateIdempotencyKey?: () => string;

  /**
   * AbortSignal for cancelling the polling operation.
   * When aborted, throws an AbortError.
   */
  signal?: AbortSignal;
}

Defined In

src/async.ts

Source

View on GitHub

Frequently Asked Questions

What is the AsyncClientOptions type?

AsyncClientOptions is a type/interface in the typescript-sdk codebase, defined in src/async.ts.

Where is AsyncClientOptions defined?

AsyncClientOptions is defined in src/async.ts at line 38.

Analyze Your Own Codebase

Get architecture documentation, dependency graphs, and domain analysis for your codebase in minutes.

Try Supermodel Free