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
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
|
// Type definitions for highlight.js v9.12
// Project: https://github.com/isagalaev/highlight.js
// Definitions by: Niklas Mollenhauer <https://github.com/nikeee>
// Jeremy Hull <https://github.com/sourrust>
// Josh Goldberg <https://github.com/joshuakgoldberg>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
declare namespace hljs
{
interface Node { }
export function highlight(
name: string,
value: string,
ignore_illegals?: boolean,
continuation?: ICompiledMode) : IHighlightResult;
export function highlightAuto(
value: string,
languageSubset?: string[]) : IAutoHighlightResult;
export function fixMarkup(value: string) : string;
export function highlightBlock(block: Node) : void;
export function configure(options: IOptions): void;
export function initHighlighting(): void;
export function initHighlightingOnLoad(): void;
export function registerLanguage(
name: string,
language: (hljs?: HLJSStatic) => IModeBase): void;
export function listLanguages(): string[];
export function getLanguage(name: string): IMode;
export function inherit(parent: Object, obj: Object): Object;
export function COMMENT(
begin: (string|RegExp),
end: (string|RegExp),
inherits: IModeBase): IMode;
// Common regexps
export var IDENT_RE: string;
export var UNDERSCORE_IDENT_RE: string;
export var NUMBER_RE: string;
export var C_NUMBER_RE: string;
export var BINARY_NUMBER_RE: string;
export var RE_STARTERS_RE: string;
// Common modes
export var BACKSLASH_ESCAPE : IMode;
export var APOS_STRING_MODE : IMode;
export var QUOTE_STRING_MODE : IMode;
export var PHRASAL_WORDS_MODE : IMode;
export var C_LINE_COMMENT_MODE : IMode;
export var C_BLOCK_COMMENT_MODE : IMode;
export var HASH_COMMENT_MODE : IMode;
export var NUMBER_MODE : IMode;
export var C_NUMBER_MODE : IMode;
export var BINARY_NUMBER_MODE : IMode;
export var CSS_NUMBER_MODE : IMode;
export var REGEX_MODE : IMode;
export var TITLE_MODE : IMode;
export var UNDERSCORE_TITLE_MODE : IMode;
export interface IHighlightResultBase
{
relevance: number;
language: string;
value: string;
}
export interface IAutoHighlightResult extends IHighlightResultBase
{
second_best?: IAutoHighlightResult;
}
export interface IHighlightResult extends IHighlightResultBase
{
top: ICompiledMode;
}
export interface HLJSStatic
{
inherit(parent: Object, obj: Object): Object;
// Common regexps
IDENT_RE: string;
UNDERSCORE_IDENT_RE: string;
NUMBER_RE: string;
C_NUMBER_RE: string;
BINARY_NUMBER_RE: string;
RE_STARTERS_RE: string;
// Common modes
BACKSLASH_ESCAPE : IMode;
APOS_STRING_MODE : IMode;
QUOTE_STRING_MODE : IMode;
PHRASAL_WORDS_MODE : IMode;
C_LINE_COMMENT_MODE : IMode;
C_BLOCK_COMMENT_MODE : IMode;
HASH_COMMENT_MODE : IMode;
NUMBER_MODE : IMode;
C_NUMBER_MODE : IMode;
BINARY_NUMBER_MODE : IMode;
CSS_NUMBER_MODE : IMode;
REGEX_MODE : IMode;
TITLE_MODE : IMode;
UNDERSCORE_TITLE_MODE : IMode;
}
// Reference:
// https://github.com/isagalaev/highlight.js/blob/master/docs/reference.rst
export interface IModeBase
{
className?: string;
aliases?: string[];
begin?: (string|RegExp);
end?: (string|RegExp);
case_insensitive?: boolean;
beginKeyword?: string;
endsWithParent?: boolean;
lexems?: string;
illegal?: string;
excludeBegin?: boolean;
excludeEnd?: boolean;
returnBegin?: boolean;
returnEnd?: boolean;
starts?: string;
subLanguage?: string;
subLanguageMode?: string;
relevance?: number;
variants?: IMode[];
}
export interface IMode extends IModeBase
{
keywords?: any;
contains?: IMode[];
}
export interface ICompiledMode extends IModeBase
{
compiled: boolean;
contains?: ICompiledMode[];
keywords?: Object;
terminators: RegExp;
terminator_end?: string;
}
export interface IOptions
{
classPrefix?: string;
tabReplace?: string;
useBR?: boolean;
languages?: string[];
}
}
export = hljs;
export as namespace hljs;
|
