Interface IEditorLanguageRegistry

Editor language interface

interface IEditorLanguageRegistry {
    addLanguage(language: IEditorLanguage): void;
    findBest(
        language: string | IEditorLanguage,
        fallback?: boolean,
    ): null | IEditorLanguage;
    findByExtension(ext: string | readonly string[]): null | IEditorLanguage;
    findByFileName(name: string): null | IEditorLanguage;
    findByMIME(mime: string | readonly string[]): null | IEditorLanguage;
    findByName(name: string): null | IEditorLanguage;
    getLanguage(
        language: string | IEditorLanguage,
    ): Promise<null | IEditorLanguage>;
    getLanguages(): IEditorLanguage[];
    highlight(
        code: string,
        language: null | IEditorLanguage,
        el: HTMLElement,
    ): Promise<void>;
}

Implemented by

EditorLanguageRegistry

Index

Methods

addLanguage findBest findByExtension findByFileName findByMIME findByName getLanguage getLanguages highlight

Methods

addLanguage

addLanguage(language: IEditorLanguage): void
Register a new language for CodeMirror
Parameters
- language: IEditorLanguage
  Language to register
Returns void
- Defined in packages/codemirror/src/token.ts:309

findBest

findBest(
language: string | IEditorLanguage,
fallback?: boolean,
): null | IEditorLanguage
Find a codemirror language by name or CodeMirror spec.
Parameters
- language: string | IEditorLanguage
  The CodeMirror language
- Optionalfallback: boolean
  Whether to fallback to default mimetype spec or not
Returns null | IEditorLanguage
The language or null
- Defined in packages/codemirror/src/token.ts:318

findByExtension

findByExtension(ext: string | readonly string[]): null | IEditorLanguage
Find a codemirror language by extension.
Parameters
- ext: string | readonly string[]
  The extension name
Returns null | IEditorLanguage
The language or null
- Defined in packages/codemirror/src/token.ts:345

findByFileName

findByFileName(name: string): null | IEditorLanguage
Find a codemirror language by filename.
Parameters
- name: string
  File name
Returns null | IEditorLanguage
The language or null
- Defined in packages/codemirror/src/token.ts:353

findByMIME

findByMIME(mime: string | readonly string[]): null | IEditorLanguage
Find a codemirror language by MIME.
Parameters
- mime: string | readonly string[]
  Mime type to look for
Returns null | IEditorLanguage
The language or null
- Defined in packages/codemirror/src/token.ts:329

findByName

findByName(name: string): null | IEditorLanguage
Find a codemirror language by name.
Parameters
- name: string
  The language name
Returns null | IEditorLanguage
The language or null
- Defined in packages/codemirror/src/token.ts:337

getLanguage

getLanguage(language: string | IEditorLanguage): Promise<null | IEditorLanguage>
Load a CodeMirror language specified by name or Codemirror spec.
Parameters
- language: string | IEditorLanguage
  The language to ensure. If it is a string, uses findBest to get the appropriate spec.
Returns Promise<null | IEditorLanguage>
A promise that resolves when the language is available.
- Defined in packages/codemirror/src/token.ts:363

getLanguages

getLanguages(): IEditorLanguage[]
Get the raw list of available languages specs.

Returns IEditorLanguage[]
The available languages
- Defined in packages/codemirror/src/token.ts:372

highlight

highlight(
    code: string,
    language: null | IEditorLanguage,
    el: HTMLElement,
): Promise<void>
Parse and style a string.
Parameters
- code: string
  Code to highlight
- language: null | IEditorLanguage
  Code language
- el: HTMLElement
  HTML element into which the highlighted code will be inserted
Returns Promise<void>
- Defined in packages/codemirror/src/token.ts:381