Class PreconditionFailedError

PreconditionFailed error is used when a precondition is not respected.

Hierarchy (view full)

ScalewayError
- PreconditionFailedError

Index

Constructors

constructor

new PreconditionFailedError(status, body, precondition, helpMessage): PreconditionFailedError
Parameters
- status: number
- body: JSONObject
- precondition: string
- helpMessage: string
Returns PreconditionFailedError
Overrides ScalewayError.constructor
- Defined in packages/clients/src/scw/errors/standard/precondition-failed-error.ts:28

Properties

`Readonly`body

body: JSONObject

The response payload.

`Optional`cause

cause?: unknown

`Readonly`helpMessage

helpMessage: string

`Readonly`message

message: string = ...

The augmented message.

name

name: string

`Readonly`precondition

precondition: string

rawMessage

rawMessage: undefined | string

The message originating from the payload.

`Optional`stack

stack?: string

`Readonly`status

status: number

The response status.

`Static` `Optional`prepareStackTrace

prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

Optional override for formatting stack traces

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

`Static`stackTraceLimit

stackTraceLimit: number

Methods

toString

toString(): string
Returns a string representation of an object.

Returns string
Inherited from ScalewayError.toString
- Defined in packages/clients/src/scw/errors/scw-error.ts:70

`Static`captureStackTrace

captureStackTrace(targetObject, constructorOpt?): void
Create .stack property on a target object
Parameters
- targetObject: object
- OptionalconstructorOpt: Function
Returns void
Inherited from ScalewayError.captureStackTrace
- Defined in node_modules/.pnpm/@types+node@18.11.18/node_modules/@types/node/globals.d.ts:4
captureStackTrace(targetObject, constructorOpt?): void
Create .stack property on a target object
Parameters
- targetObject: object
- OptionalconstructorOpt: Function
Returns void
Inherited from ScalewayError.captureStackTrace
- Defined in node_modules/.pnpm/@types+node@22.1.0/node_modules/@types/node/globals.d.ts:22

`Static`fromJSON

fromJSON(status, obj): null | PreconditionFailedError
Parameters
- status: number
- obj: Readonly<JSONObject>
Returns null | PreconditionFailedError
Overrides ScalewayError.fromJSON
- Defined in packages/clients/src/scw/errors/standard/precondition-failed-error.ts:38

Class PreconditionFailedError

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns PreconditionFailedError

Properties

`Readonly`body

`Optional`cause

`Readonly`helpMessage

`Readonly`message

name

`Readonly`precondition

rawMessage

`Optional`stack

`Readonly`status

`Static` `Optional`prepareStackTrace

See

`Static`stackTraceLimit

Methods

toString

Returns string

`Static`captureStackTrace

Parameters

Returns void

Parameters

Returns void

`Static`fromJSON

Parameters

Returns null | PreconditionFailedError

Settings

On This Page

Class PreconditionFailedError

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns PreconditionFailedError

Properties

Readonlybody

Optionalcause

ReadonlyhelpMessage

Readonlymessage

name

Readonlyprecondition

rawMessage

Optionalstack

Readonlystatus

Static OptionalprepareStackTrace

See

StaticstackTraceLimit

Methods

toString

Returns string

StaticcaptureStackTrace

Parameters

Returns void

Parameters

Returns void

StaticfromJSON

Parameters

Returns null | PreconditionFailedError

Settings

On This Page

`Readonly`body

`Optional`cause

`Readonly`helpMessage

`Readonly`message

`Readonly`precondition

`Optional`stack

`Readonly`status

`Static` `Optional`prepareStackTrace

`Static`stackTraceLimit

`Static`captureStackTrace

`Static`fromJSON