Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace languages

Index

Namespaces

Enumerations

Classes

Interfaces

Type aliases

Events

Functions

Type aliases

CharacterPair

CharacterPair: [string, string]

A tuple of two characters, like a pair of opening and closing brackets.

Definition

Definition: Location | Location[] | LocationLink[]

IMonarchLanguageAction

IMonarchLanguageRule

IShortMonarchLanguageAction

IShortMonarchLanguageAction: string

An action is either an array of actions... ... or a case statement with guards... ... or a basic action with a token value.

IShortMonarchLanguageRule1

IShortMonarchLanguageRule1: [string | RegExp, IMonarchLanguageAction]

A rule is either a regular expression and an action shorthands: [reg,act] == { regex: reg, action: act} and : [reg,act,nxt] == { regex: reg, action: act{ next: nxt }}

IShortMonarchLanguageRule2

IShortMonarchLanguageRule2: [string | RegExp, IMonarchLanguageAction, string]

ProviderResult

ProviderResult<T>: T | undefined | null | Thenable<T | undefined | null>

A provider result represents the values a provider, like the HoverProvider, may return. For once this is the actual result type T, like Hover, or a thenable that resolves to that type T. In addition, null and undefined can be returned - either directly or from a thenable.

Type parameters

  • T

TextEdit

TextEdit: { eol?: EndOfLineSequence; range: IRange; text: string }

Type declaration

Events

onLanguage

  • onLanguage(languageId: string, callback: () => void): IDisposable
  • An event emitted when a language is first time needed (e.g. a model has it set).

    Parameters

    • languageId: string
    • callback: () => void
        • (): void
        • Returns void

    Returns IDisposable

Functions

getEncodedLanguageId

  • getEncodedLanguageId(languageId: string): number
  • Parameters

    • languageId: string

    Returns number

getLanguages

  • Get the information of all the registered languages.

    Returns ILanguageExtensionPoint[]

register

  • Register information about a new language.

    Parameters

    Returns void

registerCodeActionProvider

  • Register a code action provider (used by e.g. quick fix).

    Parameters

    Returns IDisposable

registerCodeLensProvider

  • Register a code lens provider (used by e.g. inline code lenses).

    Parameters

    Returns IDisposable

registerColorProvider

  • Register a document color provider (used by Color Picker, Color Decorator).

    Parameters

    Returns IDisposable

registerCompletionItemProvider

  • Register a completion item provider (use by e.g. suggestions).

    Parameters

    Returns IDisposable

registerDeclarationProvider

  • Register a declaration provider

    Parameters

    Returns IDisposable

registerDefinitionProvider

  • Register a definition provider (used by e.g. go to definition).

    Parameters

    Returns IDisposable

registerDocumentFormattingEditProvider

registerDocumentHighlightProvider

  • Register a document highlight provider (used by e.g. highlight occurrences).

    Parameters

    Returns IDisposable

registerDocumentRangeFormattingEditProvider

registerDocumentRangeSemanticTokensProvider

registerDocumentSemanticTokensProvider

registerDocumentSymbolProvider

  • Register a document symbol provider (used by e.g. outline).

    Parameters

    Returns IDisposable

registerFoldingRangeProvider

  • Register a folding range provider

    Parameters

    Returns IDisposable

registerHoverProvider

  • Register a hover provider (used by e.g. editor hover).

    Parameters

    Returns IDisposable

registerImplementationProvider

  • Register a implementation provider (used by e.g. go to implementation).

    Parameters

    Returns IDisposable

registerLinkProvider

  • Register a link provider that can find links in text.

    Parameters

    Returns IDisposable

registerLinkedEditingRangeProvider

  • Register an linked editing range provider.

    Parameters

    Returns IDisposable

registerOnTypeFormattingEditProvider

  • Register a formatter than can do formatting as the user types.

    Parameters

    Returns IDisposable

registerReferenceProvider

  • Register a reference provider (used by e.g. reference search).

    Parameters

    Returns IDisposable

registerRenameProvider

  • Register a rename provider (used by e.g. rename symbol).

    Parameters

    Returns IDisposable

registerSelectionRangeProvider

  • Register a selection range provider

    Parameters

    Returns IDisposable

registerSignatureHelpProvider

  • Register a signature help provider (used by e.g. parameter hints).

    Parameters

    Returns IDisposable

registerTypeDefinitionProvider

  • Register a type definition provider (used by e.g. go to type definition).

    Parameters

    Returns IDisposable

setColorMap

  • setColorMap(colorMap: string[] | null): void
  • Change the color map that is used for token colors. Supported formats (hex): #RRGGBB, $RRGGBBAA, #RGB, #RGBA

    Parameters

    • colorMap: string[] | null

    Returns void

setLanguageConfiguration

  • Set the editing configuration for a language.

    Parameters

    Returns IDisposable

setMonarchTokensProvider

setTokensProvider

Generated using TypeDoc