@my-swu/simulator-client

---

@my-swu/simulator-client / ErrorPayload

Interface: ErrorPayload

Defined in: packages/ts-sdk/src/generated/types/common.ts:1549

Example:

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

const errorPayload: ErrorPayload = { code: 'invalid_selection', message: 'Deck must include a leader' }

console.log(errorPayload)

Properties

code

Example:

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

const errorPayload: ErrorPayload = { code: 'invalid_selection', message: 'Deck must include a leader' }

const { code: errorCode } = errorPayload

console.log(errorCode)

code: string

Defined in: packages/ts-sdk/src/generated/types/common.ts:1550

---

message

Example:

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

const errorPayload: ErrorPayload = { code: 'invalid_selection', message: 'Deck must include a leader' }

const { message: errorMessage } = errorPayload

console.log(errorMessage)

message: string

Defined in: packages/ts-sdk/src/generated/types/common.ts:1551

---

reportId?

Example:

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

const errorPayload: ErrorPayload = { code: 'invalid_selection', message: 'Deck must include a leader' }

const { reportId } = errorPayload

console.log(reportId)

optional reportId?: string | null

Defined in: packages/ts-sdk/src/generated/types/common.ts:1556

Opaque support correlation id, present only when the server persisted an administrator-readable diagnostic bundle.

---

retryAtMs?

Example:

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

const errorPayload: ErrorPayload = { code: 'invalid_selection', message: 'Deck must include a leader' }

const { retryAtMs } = errorPayload

console.log(retryAtMs)

optional retryAtMs?: number | null

Defined in: packages/ts-sdk/src/generated/types/common.ts:1560

Epoch milliseconds when a rate-limited request may be retried.