Skip to main content

Class: OrderBookApiError<T>

Error thrown when the CoW Protocol OrderBook API returns an error.

Type parameters​

NameType
Tunknown

Hierarchy​

  • Error

    ↳ OrderBookApiError

Constructors​

constructor​

• new OrderBookApiError<T>(response, body): OrderBookApiError<T>

Error thrown when the CoW Protocol OrderBook API returns an error.

Type parameters​

NameType
Tunknown

Parameters​

NameTypeDescription
responseResponseThe response from the CoW Protocol OrderBook API.
bodyTThe body of the response.

Returns​

OrderBookApiError<T>

Overrides​

Error.constructor

Defined in​

external/cow-sdk/src/order-book/request.ts:14

Properties​

body​

• Readonly body: T

The body of the response.

Defined in​

external/cow-sdk/src/order-book/request.ts:14

cause​

• Optional cause: unknown

Inherited from​

Error.cause

Defined in​

node_modules/typescript/lib/lib.es2022.error.d.ts:24

message​

• message: string

Inherited from​

Error.message

Defined in​

node_modules/typescript/lib/lib.es5.d.ts:1068

name​

• name: string

Inherited from​

Error.name

Defined in​

node_modules/typescript/lib/lib.es5.d.ts:1067

response​

• Readonly response: Response

The response from the CoW Protocol OrderBook API.

Defined in​

external/cow-sdk/src/order-book/request.ts:14

stack​

• Optional stack: string

Inherited from​

Error.stack

Defined in​

node_modules/typescript/lib/lib.es5.d.ts:1069

stackTraceLimit​

▪ Static stackTraceLimit: number

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from​

Error.stackTraceLimit

Defined in​

external/cow-sdk/node_modules/@types/node/globals.d.ts:161

Methods​

captureStackTrace​

▸ captureStackTrace(targetObject, constructorOpt?): void

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters​

NameType
targetObjectobject
constructorOpt?Function

Returns​

void

Inherited from​

Error.captureStackTrace

Defined in​

external/cow-sdk/node_modules/@types/node/globals.d.ts:145

prepareStackTrace​

▸ prepareStackTrace(err, stackTraces): any

Parameters​

NameType
errError
stackTracesCallSite[]

Returns​

any

See

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

Inherited from​

Error.prepareStackTrace

Defined in​

external/cow-sdk/node_modules/@types/node/globals.d.ts:149