VFileMessage

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

Message.

Extends

  • Error

Constructors

Constructor

new VFileMessage(reason, options?): VFileMessage

Defined in: node_modules/.bun/vfile-message@4.0.3/node_modules/vfile-message/lib/index.d.ts:59

Create a message for reason.

🪦 Note: also has obsolete signatures.

Parameters

ParameterTypeDescription
reasonstring-
options?nullOptions

Returns

VFileMessage

Overrides

Error.constructor

Constructor

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

Defined in: node_modules/.bun/vfile-message@4.0.3/node_modules/vfile-message/lib/index.d.ts:114

Create a message for reason.

🪦 Note: also has obsolete signatures.

Parameters

ParameterTypeDescription
reasonstring-
parentundefinednull
origin?nullstring

Returns

VFileMessage

Overrides

Error.constructor

Constructor

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

Defined in: node_modules/.bun/vfile-message@4.0.3/node_modules/vfile-message/lib/index.d.ts:169

Create a message for reason.

🪦 Note: also has obsolete signatures.

Parameters

ParameterTypeDescription
reasonstring-
placeundefinednull
origin?nullstring

Returns

VFileMessage

Overrides

Error.constructor

Constructor

new VFileMessage(reason, origin?): VFileMessage

Defined in: node_modules/.bun/vfile-message@4.0.3/node_modules/vfile-message/lib/index.d.ts:224

Create a message for reason.

🪦 Note: also has obsolete signatures.

Parameters

ParameterTypeDescription
reasonstring-
origin?nullstring

Returns

VFileMessage

Overrides

Error.constructor

Constructor

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

Defined in: node_modules/.bun/vfile-message@4.0.3/node_modules/vfile-message/lib/index.d.ts:279

Create a message for reason.

🪦 Note: also has obsolete signatures.

Parameters

ParameterTypeDescription
causeErrorVFileMessage
parentundefinednull
origin?nullstring

Returns

VFileMessage

Overrides

Error.constructor

Constructor

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

Defined in: node_modules/.bun/vfile-message@4.0.3/node_modules/vfile-message/lib/index.d.ts:334

Create a message for reason.

🪦 Note: also has obsolete signatures.

Parameters

ParameterTypeDescription
causeErrorVFileMessage
placeundefinednull
origin?nullstring

Returns

VFileMessage

Overrides

Error.constructor

Constructor

new VFileMessage(cause, origin?): VFileMessage

Defined in: node_modules/.bun/vfile-message@4.0.3/node_modules/vfile-message/lib/index.d.ts:389

Create a message for reason.

🪦 Note: also has obsolete signatures.

Parameters

ParameterTypeDescription
causeErrorVFileMessage
origin?nullstring

Returns

VFileMessage

Overrides

Error.constructor

Properties

actual

actual: undefined | string

Defined in: node_modules/.bun/vfile-message@4.0.3/node_modules/vfile-message/lib/index.d.ts:454

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

ancestors

ancestors: undefined | Node[]

Defined in: node_modules/.bun/vfile-message@4.0.3/node_modules/vfile-message/lib/index.d.ts:395

Stack of ancestor nodes surrounding the message.

cause?

optional cause?: unknown

Defined in: node_modules/.bun/bun-types@1.3.11/node_modules/bun-types/globals.d.ts:1025

The cause of the error.

Inherited from

Error.cause

column

column: undefined | number

Defined in: node_modules/.bun/vfile-message@4.0.3/node_modules/vfile-message/lib/index.d.ts:401

Starting column of message.

expected

expected: undefined | string[]

Defined in: node_modules/.bun/vfile-message@4.0.3/node_modules/vfile-message/lib/index.d.ts:460

Suggest acceptable values that can be used instead of actual.

fatal

fatal: undefined | null | boolean

Defined in: node_modules/.bun/vfile-message@4.0.3/node_modules/vfile-message/lib/index.d.ts:411

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/.bun/vfile-message@4.0.3/node_modules/vfile-message/lib/index.d.ts:417

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

line

line: undefined | number

Defined in: node_modules/.bun/vfile-message@4.0.3/node_modules/vfile-message/lib/index.d.ts:423

Starting line of error.

message

message: string

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

Inherited from

Error.message

name

name: string

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

Inherited from

Error.name

note

note: undefined | string

Defined in: node_modules/.bun/vfile-message@4.0.3/node_modules/vfile-message/lib/index.d.ts:466

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

place

place: undefined | Position | Point

Defined in: node_modules/.bun/vfile-message@4.0.3/node_modules/vfile-message/lib/index.d.ts:429

Place of message.

reason

reason: string

Defined in: node_modules/.bun/vfile-message@4.0.3/node_modules/vfile-message/lib/index.d.ts:435

Reason for message, should use markdown.

ruleId

ruleId: undefined | string

Defined in: node_modules/.bun/vfile-message@4.0.3/node_modules/vfile-message/lib/index.d.ts:441

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

source

source: undefined | string

Defined in: node_modules/.bun/vfile-message@4.0.3/node_modules/vfile-message/lib/index.d.ts:447

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

stack?

optional stack?: string

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

Inherited from

Error.stack

url

url: undefined | string

Defined in: node_modules/.bun/vfile-message@4.0.3/node_modules/vfile-message/lib/index.d.ts:475

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+node@20.19.37/node_modules/@types/node/globals.d.ts:68

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

Error.stackTraceLimit

Methods

captureStackTrace()

Call Signature

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/.bun/@types+node@20.19.37/node_modules/@types/node/globals.d.ts:52

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
ParameterType
targetObjectobject
constructorOpt?Function
Returns

void

Inherited from

Error.captureStackTrace

Call Signature

static captureStackTrace(targetObject, constructorOpt?): void

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

Create .stack property on a target object

Parameters
ParameterType
targetObjectobject
constructorOpt?Function
Returns

void

Inherited from

Error.captureStackTrace

isError()

static isError(value): value is Error

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

Check if a value is an instance of Error

Parameters

ParameterTypeDescription
valueunknownThe 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/.bun/@types+node@20.19.37/node_modules/@types/node/globals.d.ts:56

Parameters

ParameterType
errError
stackTracesCallSite[]

Returns

any

See

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

Inherited from

Error.prepareStackTrace