Class VFileMessage

Message.

Hierarchy (view full)

Constructors

constructor

Properties

actual ancestors column expected fatal file line message name note place reason ruleId source stack? url prepareStackTrace? stackTraceLimit

Methods

captureStackTrace

Constructors

constructor

Properties

actual

actual: undefined | string

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

ancestors

ancestors: undefined | "/home/runner/work/astro-node-fastify/astro-node-fastify/node_modules/@types/unist/index".Node[]

Stack of ancestor nodes surrounding the message.

column

column: undefined | number

Starting column of message.

expected

expected: undefined | string[]

Suggest acceptable values that can be used instead of actual.

fatal

fatal: undefined | null | boolean

State of problem.

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

file

file: undefined | string

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

line

line: undefined | number

Starting line of error.

message

message: string

name

name: string

note

note: undefined | string

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

place

place: undefined | "/home/runner/work/astro-node-fastify/astro-node-fastify/node_modules/@types/unist/index".Position | "/home/runner/work/astro-node-fastify/astro-node-fastify/node_modules/@types/unist/index".Point

Place of message.

reason

reason: string

Reason for message, should use markdown.

ruleId

ruleId: undefined | string

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

source

source: undefined | string

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

Optional stack

stack?: string

url

url: undefined | string

Link to docs for the message.

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

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

    • (err, stackTraces): any

    • Parameters

      Returns any

See

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

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

constructoractualancestorscolumnexpectedfatalfilelinemessagenamenoteplacereasonruleIdsourcestackurlprepareStackTracestackTraceLimitcaptureStackTrace