Errors

Errors

Error types for @quarto-wizard/core.

Provides typed error classes for handling various failure scenarios.

Classes

AuthenticationError

Defined in: packages/core/src/errors.ts:66

Error when authentication is required or failed.

Extends

• QuartoWizardError

Constructors

Constructor

TypeScript

new AuthenticationError(message, options?): AuthenticationError;

Defined in: packages/core/src/errors.ts:67

Parameters

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

Returns

AuthenticationError

Overrides

QuartoWizardError.constructor

Properties

cause?

TypeScript

optional cause: unknown;

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

Inherited from

QuartoWizardError.cause

code

TypeScript

readonly code: string;

Defined in: packages/core/src/errors.ts:25

Error code for programmatic handling.

Inherited from

QuartoWizardError.code

message

TypeScript

message: string;

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

Inherited from

QuartoWizardError.message

name

TypeScript

name: string;

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

Inherited from

QuartoWizardError.name

stack?

TypeScript

optional stack: string;

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

Inherited from

QuartoWizardError.stack

suggestion?

TypeScript

readonly optional suggestion: string;

Defined in: packages/core/src/errors.ts:27

Suggestion for how to resolve the error.

Inherited from

QuartoWizardError.suggestion

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

QuartoWizardError.stackTraceLimit

Methods

format()

TypeScript

format(): string;

Defined in: packages/core/src/errors.ts:44

Format the error for display.

Returns

string

Inherited from

QuartoWizardError.format

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

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

QuartoWizardError.prepareStackTrace

ExtensionError

Defined in: packages/core/src/errors.ts:56

Error related to extension operations (install, update, remove).

Extends

• QuartoWizardError

Constructors

Constructor

TypeScript

new ExtensionError(message, options?): ExtensionError;

Defined in: packages/core/src/errors.ts:57

Parameters

Parameter	Type
message	string
options?	QuartoWizardErrorOptions

Returns

ExtensionError

Overrides

QuartoWizardError.constructor

Properties

cause?

TypeScript

optional cause: unknown;

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

Inherited from

QuartoWizardError.cause

code

TypeScript

readonly code: string;

Defined in: packages/core/src/errors.ts:25

Error code for programmatic handling.

Inherited from

QuartoWizardError.code

message

TypeScript

message: string;

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

Inherited from

QuartoWizardError.message

name

TypeScript

name: string;

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

Inherited from

QuartoWizardError.name

stack?

TypeScript

optional stack: string;

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

Inherited from

QuartoWizardError.stack

suggestion?

TypeScript

readonly optional suggestion: string;

Defined in: packages/core/src/errors.ts:27

Suggestion for how to resolve the error.

Inherited from

QuartoWizardError.suggestion

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

QuartoWizardError.stackTraceLimit

Methods

format()

TypeScript

format(): string;

Defined in: packages/core/src/errors.ts:44

Format the error for display.

Returns

string

Inherited from

QuartoWizardError.format

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

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

QuartoWizardError.prepareStackTrace

ManifestError

Defined in: packages/core/src/errors.ts:119

Error when parsing a manifest file fails.

Extends

• QuartoWizardError

Constructors

Constructor

TypeScript

new ManifestError(message, options?): ManifestError;

Defined in: packages/core/src/errors.ts:123

Parameters

Parameter	Type
message	string
options?	{ cause?: unknown; manifestPath?: string; }
options.cause?	unknown
options.manifestPath?	string

Returns

ManifestError

Overrides

QuartoWizardError.constructor

Properties

cause?

TypeScript

optional cause: unknown;

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

Inherited from

QuartoWizardError.cause

code

TypeScript

readonly code: string;

Defined in: packages/core/src/errors.ts:25

Error code for programmatic handling.

Inherited from

QuartoWizardError.code

manifestPath?

TypeScript

readonly optional manifestPath: string;

Defined in: packages/core/src/errors.ts:121

Path to the manifest file.

message

TypeScript

message: string;

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

Inherited from

QuartoWizardError.message

name

TypeScript

name: string;

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

Inherited from

QuartoWizardError.name

stack?

TypeScript

optional stack: string;

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

Inherited from

QuartoWizardError.stack

suggestion?

TypeScript

readonly optional suggestion: string;

Defined in: packages/core/src/errors.ts:27

Suggestion for how to resolve the error.

Inherited from

QuartoWizardError.suggestion

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

QuartoWizardError.stackTraceLimit

Methods

format()

TypeScript

format(): string;

Defined in: packages/core/src/errors.ts:44

Format the error for display.

Returns

string

Inherited from

QuartoWizardError.format

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

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

QuartoWizardError.prepareStackTrace

NetworkError

Defined in: packages/core/src/errors.ts:92

Error related to network operations.

Extends

• QuartoWizardError

Constructors

Constructor

TypeScript

new NetworkError(message, options?): NetworkError;

Defined in: packages/core/src/errors.ts:96

Parameters

Parameter	Type
message	string
options?	{ cause?: unknown; statusCode?: number; }
options.cause?	unknown
options.statusCode?	number

Returns

NetworkError

Overrides

QuartoWizardError.constructor

Properties

cause?

TypeScript

optional cause: unknown;

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

Inherited from

QuartoWizardError.cause

code

TypeScript

readonly code: string;

Defined in: packages/core/src/errors.ts:25

Error code for programmatic handling.

Inherited from

QuartoWizardError.code

message

TypeScript

message: string;

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

Inherited from

QuartoWizardError.message

name

TypeScript

name: string;

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

Inherited from

QuartoWizardError.name

stack?

TypeScript

optional stack: string;

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

Inherited from

QuartoWizardError.stack

statusCode?

TypeScript

readonly optional statusCode: number;

Defined in: packages/core/src/errors.ts:94

HTTP status code if available.

suggestion?

TypeScript

readonly optional suggestion: string;

Defined in: packages/core/src/errors.ts:27

Suggestion for how to resolve the error.

Inherited from

QuartoWizardError.suggestion

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

QuartoWizardError.stackTraceLimit

Methods

format()

TypeScript

format(): string;

Defined in: packages/core/src/errors.ts:44

Format the error for display.

Returns

string

Inherited from

QuartoWizardError.format

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

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

QuartoWizardError.prepareStackTrace

QuartoWizardError

Defined in: packages/core/src/errors.ts:23

Base error class for all Quarto Wizard errors.

Extends

• Error

Extended by

• ExtensionError
• AuthenticationError
• RepositoryNotFoundError
• NetworkError
• SecurityError
• ManifestError
• VersionError

Constructors

Constructor

TypeScript

new QuartoWizardError(
   message,
   code,
   options?): QuartoWizardError;

Defined in: packages/core/src/errors.ts:29

Parameters

Parameter	Type
message	string
code	string
options?	QuartoWizardErrorOptions

Returns

QuartoWizardError

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: string;

Defined in: packages/core/src/errors.ts:25

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

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/core/src/errors.ts:27

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/core/src/errors.ts:44

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

RepositoryNotFoundError

Defined in: packages/core/src/errors.ts:79

Error when a repository or resource is not found.

Extends

• QuartoWizardError

Constructors

Constructor

TypeScript

new RepositoryNotFoundError(message, options?): RepositoryNotFoundError;

Defined in: packages/core/src/errors.ts:80

Parameters

Parameter	Type
message	string
options?	{ cause?: unknown; suggestion?: string; }
options.cause?	unknown
options.suggestion?	string

Returns

RepositoryNotFoundError

Overrides

QuartoWizardError.constructor

Properties

cause?

TypeScript

optional cause: unknown;

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

Inherited from

QuartoWizardError.cause

code

TypeScript

readonly code: string;

Defined in: packages/core/src/errors.ts:25

Error code for programmatic handling.

Inherited from

QuartoWizardError.code

message

TypeScript

message: string;

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

Inherited from

QuartoWizardError.message

name

TypeScript

name: string;

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

Inherited from

QuartoWizardError.name

stack?

TypeScript

optional stack: string;

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

Inherited from

QuartoWizardError.stack

suggestion?

TypeScript

readonly optional suggestion: string;

Defined in: packages/core/src/errors.ts:27

Suggestion for how to resolve the error.

Inherited from

QuartoWizardError.suggestion

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

QuartoWizardError.stackTraceLimit

Methods

format()

TypeScript

format(): string;

Defined in: packages/core/src/errors.ts:44

Format the error for display.

Returns

string

Inherited from

QuartoWizardError.format

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

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

QuartoWizardError.prepareStackTrace

SecurityError

Defined in: packages/core/src/errors.ts:109

Error related to security issues (path traversal, zip bombs, etc.).

Extends

• QuartoWizardError

Constructors

Constructor

TypeScript

new SecurityError(message, options?): SecurityError;

Defined in: packages/core/src/errors.ts:110

Parameters

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

Returns

SecurityError

Overrides

QuartoWizardError.constructor

Properties

cause?

TypeScript

optional cause: unknown;

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

Inherited from

QuartoWizardError.cause

code

TypeScript

readonly code: string;

Defined in: packages/core/src/errors.ts:25

Error code for programmatic handling.

Inherited from

QuartoWizardError.code

message

TypeScript

message: string;

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

Inherited from

QuartoWizardError.message

name

TypeScript

name: string;

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

Inherited from

QuartoWizardError.name

stack?

TypeScript

optional stack: string;

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

Inherited from

QuartoWizardError.stack

suggestion?

TypeScript

readonly optional suggestion: string;

Defined in: packages/core/src/errors.ts:27

Suggestion for how to resolve the error.

Inherited from

QuartoWizardError.suggestion

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

QuartoWizardError.stackTraceLimit

Methods

format()

TypeScript

format(): string;

Defined in: packages/core/src/errors.ts:44

Format the error for display.

Returns

string

Inherited from

QuartoWizardError.format

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

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

QuartoWizardError.prepareStackTrace

VersionError

Defined in: packages/core/src/errors.ts:136

Error when a version cannot be resolved.

Extends

• QuartoWizardError

Constructors

Constructor

TypeScript

new VersionError(message, options?): VersionError;

Defined in: packages/core/src/errors.ts:137

Parameters

Parameter	Type
message	string
options?	QuartoWizardErrorOptions

Returns

VersionError

Overrides

QuartoWizardError.constructor

Properties

cause?

TypeScript

optional cause: unknown;

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

Inherited from

QuartoWizardError.cause

code

TypeScript

readonly code: string;

Defined in: packages/core/src/errors.ts:25

Error code for programmatic handling.

Inherited from

QuartoWizardError.code

message

TypeScript

message: string;

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

Inherited from

QuartoWizardError.message

name

TypeScript

name: string;

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

Inherited from

QuartoWizardError.name

stack?

TypeScript

optional stack: string;

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

Inherited from

QuartoWizardError.stack

suggestion?

TypeScript

readonly optional suggestion: string;

Defined in: packages/core/src/errors.ts:27

Suggestion for how to resolve the error.

Inherited from

QuartoWizardError.suggestion

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

QuartoWizardError.stackTraceLimit

Methods

format()

TypeScript

format(): string;

Defined in: packages/core/src/errors.ts:44

Format the error for display.

Returns

string

Inherited from

QuartoWizardError.format

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

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

QuartoWizardError.prepareStackTrace

Interfaces

QuartoWizardErrorOptions

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

Options for constructing a QuartoWizardError.

Properties

Property	Type	Description	Defined in
cause?	unknown	Original error that caused this error.	packages/core/src/errors.ts:17
suggestion?	string	Suggestion for how to resolve the error.	packages/core/src/errors.ts:15

Functions

isQuartoWizardError()

TypeScript

function isQuartoWizardError(error): error is QuartoWizardError;

Defined in: packages/core/src/errors.ts:146

Check if an error is a QuartoWizardError.

Parameters

Parameter	Type
error	unknown

Returns

error is QuartoWizardError

wrapError()

TypeScript

function wrapError(error, context?): QuartoWizardError;

Defined in: packages/core/src/errors.ts:153

Wrap an unknown error as a QuartoWizardError.

Parameters

Parameter	Type
error	unknown
context?	string

Returns

QuartoWizardError