Errors

Thursday, the 26th of February, 2026
Mickaël CANOUIL, Ph.D. ORCID
Independent Contractor

Errors

Error types for @quarto-wizard/snippets.

Classes

Functions

SnippetError

Defined in: packages/snippets/src/errors.ts:11

Error when parsing a snippet file fails.

Extends

  • Error

Constructors

Constructor

TypeScript
new SnippetError(message, options?): SnippetError;

Defined in: packages/snippets/src/errors.ts:19

Parameters
Parameter Type
message string
options? { cause?: unknown; snippetPath?: string; }
options.cause? unknown
options.snippetPath? string
Returns

SnippetError

Overrides
TypeScript
Error.constructor

Properties

cause?

TypeScript
optional cause: unknown;

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

Inherited from
TypeScript
Error.cause

code

TypeScript
readonly code: "SNIPPET_ERROR" = "SNIPPET_ERROR";

Defined in: packages/snippets/src/errors.ts:13

Error code for programmatic handling.

message

TypeScript
message: string;

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from
TypeScript
Error.message

name

TypeScript
name: string;

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

Inherited from
TypeScript
Error.name

snippetPath?

TypeScript
readonly optional snippetPath: string;

Defined in: packages/snippets/src/errors.ts:15

Path to the snippet file.

stack?

TypeScript
optional stack: string;

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from
TypeScript
Error.stack

suggestion?

TypeScript
readonly optional suggestion: string;

Defined in: packages/snippets/src/errors.ts:17

Suggestion for how to resolve the error.

stackTraceLimit

TypeScript
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
TypeScript
Error.stackTraceLimit

Methods

format()

TypeScript
format(): string;

Defined in: packages/snippets/src/errors.ts:33

Format the error for display.

Returns

string

captureStackTrace()

TypeScript
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.

JavaScript
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:

JavaScript
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
Parameter Type
targetObject object
constructorOpt? Function
Returns

void

Inherited from
TypeScript
Error.captureStackTrace

prepareStackTrace()

TypeScript
static prepareStackTrace(err, stackTraces): any;

Defined in: node_modules/@types/node/globals.d.ts:55

Parameters
Parameter Type
err Error
stackTraces CallSite[]
Returns

any

See

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

Inherited from
TypeScript
Error.prepareStackTrace

getErrorMessage

TypeScript
function getErrorMessage(error): string;

Defined in: packages/snippets/src/errors.ts:45

Extract a human-readable message from an unknown error value.

Parameters

Parameter Type
error unknown

Returns

string

Back to top

Reuse

MIT