Class StreamRequestError

Hierarchy

Error
- StreamRequestError

Index

Constructors

constructor

Properties

Methods

captureStackTrace

Constructors

constructor

new StreamRequestError(requestId: string, requestPayload: IStreamRequest, summary: undefined | null | string, details: undefined | null | string): StreamRequestError

Overrides Error.constructor
- Defined in packages/stream-api/src/errors.ts:4
Parameters
- requestId: string
- requestPayload: IStreamRequest
- summary: undefined | null | string
- details: undefined | null | string
Returns StreamRequestError

Properties

Readonly details

details: undefined | null | string

message

message: string

name

name: string

Readonly requestId

requestId: string

Readonly requestPayload

requestPayload: IStreamRequest

Optional stack

stack?: string

Readonly summary

summary: undefined | null | string

Static Optional prepareStackTrace

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

Type declaration

- (err: Error, stackTraces: CallSite[]): any
- Optional override for formatting stack traces
  
  see
  https://v8.dev/docs/stack-trace-api#customizing-stack-traces
  
  Parameters
  - err: Error
  - stackTraces: CallSite[]
  Returns any

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

captureStackTrace(targetObject: object, constructorOpt?: Function): void

Inherited from Error.captureStackTrace
- Defined in node_modules/@types/node/globals.d.ts:4
Create .stack property on a target object

Parameters
- targetObject: object
- Optional constructorOpt: Function
Returns void