HighlightingService
Methods
Section titled “Methods”awaitIdle()
Section titled “awaitIdle()”awaitIdle():
Promise<void>
Returns
Section titled “Returns”Promise<void>
awaitRuntimeSessionIdle()
Section titled “awaitRuntimeSessionIdle()”awaitRuntimeSessionIdle(
runtimeSessionId):Promise<void>
Parameters
Section titled “Parameters”runtimeSessionId
Section titled “runtimeSessionId”string
Returns
Section titled “Returns”Promise<void>
canPrepareDiff()
Section titled “canPrepareDiff()”canPrepareDiff(
file,theme):boolean
False when the diff is prepared, on screen, or being prepared under this theme’s engine.
Parameters
Section titled “Parameters”DiffFile
Returns
Section titled “Returns”boolean
dispose()
Section titled “dispose()”dispose():
Promise<void>
Returns
Section titled “Returns”Promise<void>
documentBackend()
Section titled “documentBackend()”documentBackend(
theme):HighlightingDocumentBackend
The backend documents and diffs use under this theme; one object per source and engine.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”grammarFor()
Section titled “grammarFor()”grammarFor(
language):string|null
The grammar a label or language id selects, or null for plain text.
Parameters
Section titled “Parameters”language
Section titled “language”string
Returns
Section titled “Returns”string | null
highlight()
Section titled “highlight()”highlight(
text,options):Promise<HighlightResult>
Highlights a standalone snippet off the main thread. Rejects on abort, failure or disposal.
Parameters
Section titled “Parameters”string
options
Section titled “options”Returns
Section titled “Returns”Promise<HighlightResult>
highlighterProvider()
Section titled “highlighterProvider()”highlighterProvider(
theme):EditorHighlighterProvider
Imported-theme colors for documents; one provider per theme source.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”EditorHighlighterProvider
inspect()
Section titled “inspect()”inspect():
HighlightingServiceSnapshot
Returns
Section titled “Returns”prepareDiff()
Section titled “prepareDiff()”prepareDiff(
file,theme,signal?):Promise<boolean>
Parses a diff ahead of its view and keeps the result; resolves true when it kept one.
Parameters
Section titled “Parameters”DiffFile
signal?
Section titled “signal?”AbortSignal
Returns
Section titled “Returns”Promise<boolean>
showDiff()
Section titled “showDiff()”showDiff(
view,file,side,theme):object
Shows a diff with shared source readers; disposing releases this view’s interests.
Parameters
Section titled “Parameters”DiffFile
DiffGutterSide
Returns
Section titled “Returns”object
dispose()
Section titled “dispose()”dispose():
void
Returns
Section titled “Returns”void
syntaxProvider()
Section titled “syntaxProvider()”syntaxProvider():
TreeSitterSyntaxProvider
Structure (folds, brackets, injections, selection) and built-in palette colors.
Returns
Section titled “Returns”TreeSitterSyntaxProvider
usesHighlighter()
Section titled “usesHighlighter()”usesHighlighter(
theme):boolean
Whether documents under this theme take colors from the highlighter provider.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”boolean