Class: WorkspaceError

Documentation / @wtf/project-resolve / errors / WorkspaceError

Defined in: packages/project-resolve/src/errors.ts:30

A workspace that a file of it says wrong: a package.json that is no JSON object, workspaces or the packages of a pnpm-workspace.yaml that is no list of patterns, or two packages of one name, which no package manager takes.

Extends

ResolveError

Constructors

Constructor

new WorkspaceError(
   file,
   reason,
   options?
): WorkspaceError;

Defined in: packages/project-resolve/src/errors.ts:34

Parameters

Parameter	Type
`file`	`string`
`reason`	`string`
`options?`	`ErrorOptions`

Returns

WorkspaceError

Overrides

ResolveError.constructor

Properties

Property	Modifier	Type	Default value	Description	Inherited from	Defined in
`cause?`	`public`	`unknown`	`undefined`	-	`ResolveError`.`cause`	-
`code`	`readonly`	`string`	`undefined`	-	`ResolveError`.`code`	packages/project-resolve/src/errors.ts:14
`exitCode`	`readonly`	`number`	`1`	What a command that fails by it exits with.	`ResolveError`.`exitCode`	packages/project-resolve/src/errors.ts:16
`file`	`readonly`	`string`	`undefined`	The file that says it: a package.json, or a pnpm-workspace.yaml.	-	packages/project-resolve/src/errors.ts:32
`message`	`public`	`string`	`undefined`	-	`ResolveError`.`message`	-
`name`	`public`	`string`	`undefined`	-	`ResolveError`.`name`	-
`stack?`	`public`	`string`	`undefined`	-	`ResolveError`.`stack`	-
`stackTraceLimit`	`static`	`number`	`undefined`	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.	`ResolveError`.`stackTraceLimit`	-

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void;

Defined in: @types/node

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

Parameter	Type
`targetObject`	`object`
`constructorOpt?`	`Function`

Returns

void

Inherited from

ResolveError.captureStackTrace

isError()

static isError(error): error is Error;

Defined in: typescript

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

Parameters

Parameter	Type
`error`	`unknown`

Returns

error is Error

Inherited from

ResolveError.isError

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any;

Defined in: @types/node

Parameters

Parameter	Type
`err`	`Error`
`stackTraces`	`CallSite`[]

Returns

any

See

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

Inherited from

ResolveError.prepareStackTrace