Skip to content

@my-swu/simulator-client


@my-swu/simulator-client / EngineRequestAbortedErrorOptions

Interface: EngineRequestAbortedErrorOptions ​

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

Context captured for one cancelled HTTP request.

These fields mirror EngineHttpErrorOptions so a UI can log both failure channels the same way.

Example:

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

const engineRequestAbortedErrorOptions: EngineRequestAbortedErrorOptions = {}

console.log(engineRequestAbortedErrorOptions)

Example ​

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

const timedOutOptions: EngineRequestAbortedErrorOptions = {
  method: 'GET',
  timeoutMs: 5_000,
  url: 'http://127.0.0.1:4000/api/matches/match_123',
}

console.log(timedOutOptions.timeoutMs)

See ​

https://simulator-sdk.my-swu.com/guide/errors

Properties ​

method? ​

Example:

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

const engineRequestAbortedErrorOptions: EngineRequestAbortedErrorOptions = {}

const { method: httpMethod } = engineRequestAbortedErrorOptions

console.log(httpMethod)

optional method?: string

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

HTTP method used for the cancelled request.


timeoutMs? ​

Example:

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

const engineRequestAbortedErrorOptions: EngineRequestAbortedErrorOptions = {}

const { timeoutMs } = engineRequestAbortedErrorOptions

console.log(timeoutMs)

optional timeoutMs?: number

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

Timeout that applied to the request, when one did.


url? ​

Example:

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

const engineRequestAbortedErrorOptions: EngineRequestAbortedErrorOptions = {}

const { url: requestUrl } = engineRequestAbortedErrorOptions

console.log(requestUrl)

optional url?: string

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

Fully resolved request URL.

Released under the MIT License.