TransportError

Defined in: metacomputer/gen-framework/client-and-test-utils/client-sdk-ts/packages/client-sdk/src/errors.ts:20

Extends

SdkError

Constructors

Constructor

new TransportError(code, message, options?): TransportError

Defined in: metacomputer/gen-framework/client-and-test-utils/client-sdk-ts/packages/client-sdk/src/errors.ts:13

Parameters

code

string

message

string

options?

ErrorOptions

Returns

TransportError

Inherited from

SdkError.constructor

Properties

code

readonly code: string

Defined in: metacomputer/gen-framework/client-and-test-utils/client-sdk-ts/packages/client-sdk/src/errors.ts:11

Inherited from

SdkError.code

stackTraceLimit

static stackTraceLimit: number

Defined in: metacomputer/gen-framework/client-and-test-utils/client-sdk-ts/node_modules/@types/node/globals.d.ts:67 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

SdkError.stackTraceLimit

cause?

optional cause?: unknown

Defined in: metacomputer/gen-framework/client-and-test-utils/client-sdk-ts/node_modules/typescript/lib/lib.es2022.error.d.ts:26

Inherited from

SdkError.cause

name

name: string

Defined in: metacomputer/gen-framework/client-and-test-utils/client-sdk-ts/node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from

SdkError.name

message

message: string

Defined in: metacomputer/gen-framework/client-and-test-utils/client-sdk-ts/node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from

SdkError.message

stack?

optional stack?: string

Defined in: metacomputer/gen-framework/client-and-test-utils/client-sdk-ts/node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from

SdkError.stack

Methods

invalidUrl()

static invalidUrl(url, cause?): TransportError

Defined in: metacomputer/gen-framework/client-and-test-utils/client-sdk-ts/packages/client-sdk/src/errors.ts:21

Parameters

url

string

cause?

unknown

Returns

TransportError

requestFailed()

static requestFailed(message, cause?): TransportError

Defined in: metacomputer/gen-framework/client-and-test-utils/client-sdk-ts/packages/client-sdk/src/errors.ts:29

Parameters

message

string

cause?

unknown

Returns

TransportError

responseReadFailed()

static responseReadFailed(message, cause?): TransportError

Defined in: metacomputer/gen-framework/client-and-test-utils/client-sdk-ts/packages/client-sdk/src/errors.ts:37

Parameters

message

string

cause?

unknown

Returns

TransportError

other()

static other(message, cause?): TransportError

Defined in: metacomputer/gen-framework/client-and-test-utils/client-sdk-ts/packages/client-sdk/src/errors.ts:45

Parameters

message

string

cause?

unknown

Returns

TransportError

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: metacomputer/gen-framework/client-and-test-utils/client-sdk-ts/node_modules/@types/node/globals.d.ts:51 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

targetObject

object

constructorOpt?

Function

Returns

void

Inherited from

SdkError.captureStackTrace

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Defined in: metacomputer/gen-framework/client-and-test-utils/client-sdk-ts/node_modules/@types/node/globals.d.ts:55

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

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

Inherited from

SdkError.prepareStackTrace

​Extends

​Constructors

​Constructor

​Parameters

code

message

options?

​Returns

​Inherited from

​Properties

​code

​Inherited from

​stackTraceLimit

​Inherited from

​cause?

​Inherited from

​name

​Inherited from

​message

​Inherited from

​stack?

​Inherited from

​Methods

​invalidUrl()

​Parameters

url

cause?

​Returns

​requestFailed()

​Parameters

message

cause?

​Returns

​responseReadFailed()

​Parameters

message

cause?

​Returns

​other()

​Parameters

message

cause?

​Returns

​captureStackTrace()

​Parameters

targetObject

constructorOpt?

​Returns

​Inherited from

​prepareStackTrace()

​Parameters

err

stackTraces

​Returns

​See

​Inherited from

Extends

Constructors

Constructor

Parameters

Returns

Inherited from

Properties

code

Inherited from

stackTraceLimit

Inherited from

cause?

Inherited from

name

Inherited from

message

Inherited from

stack?

Inherited from

Methods

invalidUrl()

Parameters

Returns

requestFailed()

Parameters

Returns

responseReadFailed()

Parameters

Returns

other()

Parameters

Returns

captureStackTrace()

Parameters

Returns

Inherited from

prepareStackTrace()

Parameters

Returns

See

Inherited from