Interface IEditorLanguageRegistry

Editor language interface

Hierarchy

IEditorLanguageRegistry

Index

Methods

addLanguage findBest findByExtension findByFileName findByMIME findByName getLanguage getLanguages highlight

Methods

addLanguage

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

findBest

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

findByExtension

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

findByFileName

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

findByMIME

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

findByName

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

getLanguage

getLanguage(language): Promise<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<IEditorLanguage>
A promise that resolves when the language is available.
- Defined in packages/codemirror/lib/token.d.ts:308

getLanguages

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

Returns IEditorLanguage[]
The available languages
- Defined in packages/codemirror/lib/token.d.ts:314

highlight

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

Generated using TypeDoc