Class IssueError

Hierarchy

Error
- IssueError

Index

Constructors

Properties

issue message name stack? prepareStackTrace? stackTraceLimit

Methods

captureStackTrace generateAndThrow generateAndThrowInternalError

Constructors

constructor

new IssueError(issue: Issue, ...params: any[]): IssueError
Constructor.
Parameters
- issue: Issue
  The associated HED issue.
- ...params: any[]
  Extra parameters (to be forwarded to the Error constructor).
Returns IssueError
Overrides Error.constructor
- Defined in src/issues/issues.js:18

Properties

issue

issue: Issue

The associated HED issue.

message

message: string

name

name: string

`Optional`stack

stack?: string

`Static` `Optional`prepareStackTrace

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

Optional override for formatting stack traces

See

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

`Static`stackTraceLimit

stackTraceLimit: number

Methods

`Static`captureStackTrace

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

`Static`generateAndThrow

generateAndThrow(internalCode: string, parameters?: {}): void
Generate a new Issue object and immediately throw it as an IssueError.
Parameters
- internalCode: string
  The internal error code.
- parameters: {} = {}
  The error string parameters.
Returns void
Throws
Corresponding to the generated Issue.
- Defined in src/issues/issues.js:40

`Static`generateAndThrowInternalError

generateAndThrowInternalError(message?: string): void
Generate a new Issue object for an internal error and immediately throw it as an IssueError.
Parameters
- message: string = 'Unknown internal error'
  A message describing the internal error.
Returns void
Throws
Corresponding to the generated internal error Issue.
- Defined in src/issues/issues.js:50