Interface IEditor

Code editor accessor.

interface IEditor {
    getEditor(): null | CodeEditor.IEditor;
    ready(): Promise<CodeEditor.IEditor>;
    reveal(): Promise<CodeEditor.IEditor>;
}

Index

Methods

getEditor ready reveal

Methods

getEditor

getEditor(): null | CodeEditor.IEditor
CodeEditor getter.

It will return null if the editor is not yet instantiated; e.g. to support windowed notebook.

Returns null | CodeEditor.IEditor
- Defined in packages/lsp/src/tokens.ts:215

ready

ready(): Promise<CodeEditor.IEditor>
Promise getter that resolved when the editor is instantiated.

Returns Promise<CodeEditor.IEditor>
- Defined in packages/lsp/src/tokens.ts:220

reveal

reveal(): Promise<CodeEditor.IEditor>
Reveal the code editor in viewport.

Notes
The promise will resolve when the editor is instantiated and in the viewport.

Returns Promise<CodeEditor.IEditor>
- Defined in packages/lsp/src/tokens.ts:229