blob: 03c9b7550d74c4d38dbfe61b49a1c4671e5bd0ba (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
|
// TypeScript Version: 3.0
import * as Unist from 'unist'
declare namespace vfileMessage {
/**
* Create a virtual message.
*/
interface VFileMessage extends Error {
/**
* Constructor of a message for `reason` at `position` from `origin`.
* When an error is passed in as `reason`, copies the `stack`.
*
* @param reason Reason for message (`string` or `Error`). Uses the stack and message of the error if given.
* @param position Place at which the message occurred in a file (`Node`, `Position`, or `Point`, optional).
* @param origin Place in code the message originates from (`string`, optional).
*/
(
reason: string | Error,
position?: Unist.Node | Unist.Position | Unist.Point,
origin?: string
): VFileMessage
/**
* Category of message.
*/
ruleId: string | null
/**
* Reason for message.
*/
reason: string
/**
* Starting line of error.
*/
line: number | null
/**
* Starting column of error.
*/
column: number | null
/**
* Full range information, when available.
* Has start and end properties, both set to an object with line and column, set to number?.
*/
location: Unist.Position
/**
* Namespace of warning.
*/
source: string | null
/**
* If true, marks associated file as no longer processable.
*/
fatal?: boolean | null
/**
* You may add a file property with a path of a file (used throughout the VFile ecosystem).
*/
file?: string
/**
* You may add a note property with a long form description of the message (supported by vfile-reporter).
*/
note?: string
/**
* You may add a url property with a link to documentation for the message.
*/
url?: string
/**
* It’s OK to store custom data directly on the VMessage, some of those are handled by utilities.
*/
[key: string]: unknown
}
}
declare const vfileMessage: vfileMessage.VFileMessage
export = vfileMessage
|
