VFileMessage

Defined in: node_modules/vfile-message/lib/index.d.ts:4

Message.

Extends

Error

Constructors

Constructor

new VFileMessage(reason, options?): VFileMessage

Defined in: node_modules/vfile-message/lib/index.d.ts:5

Parameters

Parameter	Type
`reason`	`string`
`options?`	`null`

Returns

VFileMessage

Overrides

Error.constructor

Constructor

new VFileMessage(reason, parent, origin?): VFileMessage

Defined in: node_modules/vfile-message/lib/index.d.ts:6

Parameters

Parameter	Type
`reason`	`string`
`parent`	`undefined`
`origin?`	`null`

Returns

VFileMessage

Overrides

Error.constructor

Constructor

new VFileMessage(reason, place, origin?): VFileMessage

Defined in: node_modules/vfile-message/lib/index.d.ts:11

Parameters

Parameter	Type
`reason`	`string`
`place`	`undefined`
`origin?`	`null`

Returns

VFileMessage

Overrides

Error.constructor

Constructor

new VFileMessage(reason, origin?): VFileMessage

Defined in: node_modules/vfile-message/lib/index.d.ts:16

Parameters

Parameter	Type
`reason`	`string`
`origin?`	`null`

Returns

VFileMessage

Overrides

Error.constructor

Constructor

new VFileMessage(cause, parent, origin?): VFileMessage

Defined in: node_modules/vfile-message/lib/index.d.ts:17

Parameters

Parameter	Type
`cause`	`Error`
`parent`	`undefined`
`origin?`	`null`

Returns

VFileMessage

Overrides

Error.constructor

Constructor

new VFileMessage(cause, place, origin?): VFileMessage

Defined in: node_modules/vfile-message/lib/index.d.ts:22

Parameters

Parameter	Type
`cause`	`Error`
`place`	`undefined`
`origin?`	`null`

Returns

VFileMessage

Overrides

Error.constructor

Constructor

new VFileMessage(cause, origin?): VFileMessage

Defined in: node_modules/vfile-message/lib/index.d.ts:27

Parameters

Parameter	Type
`cause`	`Error`
`origin?`	`null`

Returns

VFileMessage

Overrides

Error.constructor

Properties

actual

actual: undefined | string

Defined in: node_modules/vfile-message/lib/index.d.ts:92

Specify the source value that’s being reported, which is deemed incorrect.

ancestors

ancestors: undefined | Node[]

Defined in: node_modules/vfile-message/lib/index.d.ts:33

Stack of ancestor nodes surrounding the message.

cause?

optional cause: unknown

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

The cause of the error.

Inherited from

Error.cause

column

column: undefined | number

Defined in: node_modules/vfile-message/lib/index.d.ts:39

Starting column of message.

expected

expected: undefined | string[]

Defined in: node_modules/vfile-message/lib/index.d.ts:98

Suggest acceptable values that can be used instead of actual.

fatal

fatal: undefined | null | boolean

Defined in: node_modules/vfile-message/lib/index.d.ts:49

State of problem.

true — error, file not usable
false — warning, change may be needed
undefined — change likely not needed

file

file: undefined | string

Defined in: node_modules/vfile-message/lib/index.d.ts:55

Path of a file (used throughout the VFile ecosystem).

line

line: undefined | number

Defined in: node_modules/vfile-message/lib/index.d.ts:61

Starting line of error.

message

message: string

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

Inherited from

Error.message

name

name: string

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

Inherited from

Error.name

note

note: undefined | string

Defined in: node_modules/vfile-message/lib/index.d.ts:104

Long form description of the message (you should use markdown).

place

place: undefined | Position | Point

Defined in: node_modules/vfile-message/lib/index.d.ts:67

Place of message.

reason

reason: string

Defined in: node_modules/vfile-message/lib/index.d.ts:73

Reason for message, should use markdown.

ruleId

ruleId: undefined | string

Defined in: node_modules/vfile-message/lib/index.d.ts:79

Category of message (example: 'my-rule').

source

source: undefined | string

Defined in: node_modules/vfile-message/lib/index.d.ts:85

Namespace of message (example: 'my-package').

stack?

optional stack: string

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

Inherited from

Error.stack

url

url: undefined | string

Defined in: node_modules/vfile-message/lib/index.d.ts:113

Link to docs for the message.

👉 Note: this must be an absolute URL that can be passed as x to new URL(x).

stackTraceLimit

static stackTraceLimit: number

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

The maximum number of stack frames to capture.

Inherited from

Error.stackTraceLimit

Methods

captureStackTrace()

Call Signature

static captureStackTrace(targetObject, constructorOpt?): void

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

Create .stack property on a target object

Parameters

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

Returns

void

Inherited from

Error.captureStackTrace

Call Signature

static captureStackTrace(targetObject, constructorOpt?): void

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

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

Error.captureStackTrace

isError()

static isError(value): value is Error

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

Check if a value is an instance of Error

Parameters

Parameter	Type	Description
`value`	`unknown`	The value to check

Returns

value is Error

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

Inherited from

Error.isError

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

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

Parameters

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

Returns

any

See

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

Inherited from

Error.prepareStackTrace