Skip to main content

Class: RequiredBlockError

Defined in: src/errors.ts:147

Extends​

Constructors​

Constructor​

new RequiredBlockError(message, span, source, templateName): RequiredBlockError

Defined in: src/errors.ts:95

Parameters​

message​

string

span​

Token

source​

string

templateName​

string

Returns​

RequiredBlockError

Inherited from​

TemplateInheritanceError.constructor

Properties​

cause?​

optional cause?: unknown

Defined in: docs/node_modules/typescript/lib/lib.es2022.error.d.ts:24

The cause of the error.

Inherited from​

TemplateInheritanceError.cause

diagnostic​

readonly diagnostic: Diagnostic

Defined in: src/errors.ts:76

Inherited from​

TemplateInheritanceError.diagnostic

message​

message: string

Defined in: src/errors.ts:66

Inherited from​

TemplateInheritanceError.message

name​

name: string

Defined in: docs/node_modules/typescript/lib/lib.es5.d.ts:1074

Inherited from​

TemplateInheritanceError.name

source​

readonly source: string

Defined in: src/errors.ts:98

Inherited from​

TemplateInheritanceError.source

span​

readonly span: Token

Defined in: src/errors.ts:97

Inherited from​

TemplateInheritanceError.span

stack?​

optional stack?: string

Defined in: docs/node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from​

TemplateInheritanceError.stack

templateName​

readonly templateName: string

Defined in: src/errors.ts:99

Inherited from​

TemplateInheritanceError.templateName

stackTraceLimit​

static stackTraceLimit: number

Defined in: 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​

TemplateInheritanceError.stackTraceLimit

Accessors​

label​

Get Signature​

get label(): string

Defined in: src/errors.ts:148

Returns​

string

Overrides​

TemplateInheritanceError.label

Methods​

render()​

render(): string

Defined in: src/errors.ts:85

Returns​

string

Inherited from​

TemplateInheritanceError.render

captureStackTrace()​

Call Signature​

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: 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​

TemplateInheritanceError.captureStackTrace

Call Signature​

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/bun-types/globals.d.ts:1042

Create .stack property on a target object

Parameters​
targetObject​

object

constructorOpt?​

Function

Returns​

void

Inherited from​

TemplateInheritanceError.captureStackTrace

isError()​

Call Signature​

static isError(error): error is Error

Defined in: docs/node_modules/typescript/lib/lib.esnext.error.d.ts:21

Indicates whether the argument provided is a built-in Error instance or not.

Parameters​
error​

unknown

Returns​

error is Error

Inherited from​

TemplateInheritanceError.isError

Call Signature​

static isError(value): value is Error

Defined in: node_modules/bun-types/globals.d.ts:1037

Check if a value is an instance of Error

Parameters​
value​

unknown

The value to check

Returns​

value is Error

True if the value is an instance of Error, false otherwise

Inherited from​

TemplateInheritanceError.isError

prepareStackTrace()​

static prepareStackTrace(err, stackTraces): any

Defined in: 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​

TemplateInheritanceError.prepareStackTrace