Skip to content

SeamAPIError.md

Latest commit

 

History

History
201 lines (110 loc) · 3 KB

SeamAPIError.md

File metadata and controls

201 lines (110 loc) · 3 KB

seamapi / Exports / SeamAPIError

Class: SeamAPIError

Hierarchy

  • Error

    ↳ SeamAPIError

Table of contents

Constructors

Properties

Methods

Constructors

constructor

• new SeamAPIError(status, requestId, metadata?)

Parameters

Name Type
status number
requestId string
metadata? SeamAPIErrorMetadata

Overrides

Error.constructor

Defined in

src/lib/api-error.ts:8

Properties

message

• message: string

Inherited from

Error.message

Defined in

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

metadata

• Optional metadata: SeamAPIErrorMetadata

name

• name: string

Inherited from

Error.name

Defined in

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

requestId

• requestId: string

stack

• Optional stack: string

Inherited from

Error.stack

Defined in

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

status

• status: number

prepareStackTrace

▪ Static Optional prepareStackTrace: (err: Error, stackTraces: CallSite[]) => any

Type declaration

▸ (err, stackTraces): any

Optional override for formatting stack traces

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

Parameters
Name Type
err Error
stackTraces CallSite[]
Returns

any

Inherited from

Error.prepareStackTrace

Defined in

node_modules/@types/node/globals.d.ts:11

stackTraceLimit

▪ Static stackTraceLimit: number

Inherited from

Error.stackTraceLimit

Defined in

node_modules/@types/node/globals.d.ts:13

Methods

toString

▸ toString(): string

Returns

string

Defined in

src/lib/api-error.ts:20

captureStackTrace

▸ Static captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters

Name Type
targetObject object
constructorOpt? Function

Returns

void

Inherited from

Error.captureStackTrace

Defined in

node_modules/@types/node/globals.d.ts:4