Class PermitContextError

The PermitContextError class represents an error that occurs when an API method is called with insufficient context (not knowing in what environment, project or organization the API call is being made). Some of the input for the API method is provided via the SDK context. If the context is missing some data required for a method - the API call will fail.

Hierarchy

Error
- PermitContextError

Index

Constructors

Properties

message name stack? prepareStackTrace? stackTraceLimit

Methods

captureStackTrace

Constructors

constructor

new PermitContextError(message): PermitContextError
Parameters
- message: string
Returns PermitContextError
Overrides Error.constructor
- Defined in src/api/context.ts:68

Properties

message

message: string

name

name: string

`Optional` stack

stack?: string

`Static` `Optional` prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Type declaration

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

`Static` stackTraceLimit

stackTraceLimit: number

Methods

`Static` captureStackTrace

captureStackTrace(targetObject, constructorOpt?): void
Create .stack property on a target object
Parameters
- targetObject: object
- Optional constructorOpt: Function
Returns void
Inherited from Error.captureStackTrace
- Defined in node_modules/@types/node/globals.d.ts:4

Generated using TypeDoc