Skip to content

@my-swu/simulator-client


@my-swu/simulator-client / EngineRequestAbortKind

Type Alias: EngineRequestAbortKind ​

EngineRequestAbortKind = "aborted" | "timeout"

Defined in: packages/ts-sdk/src/internal/abort-error.ts:10

Why one simulator HTTP request stopped before the server answered.

  • aborted: the caller's own AbortSignal fired.
  • timeout: the per-call or client-level timeout elapsed first.

When a caller passes both a signal and a timeout, whichever fired first names the kind.

Example:

ts
import type { EngineRequestAbortKind } from '@my-swu/simulator-client'

// 'timeout' means a deadline fired; 'aborted' means the caller's signal did.
const engineRequestAbortKind: EngineRequestAbortKind = 'timeout'

console.log(engineRequestAbortKind)

Released under the MIT License.