All 9 public APIs exported from the snippetmanager module, with declarations, documentation, and source-backed examples.
Generated from typings/index.d.ts @ 555f5ceon
Get snippet session by bufnr, only returns active session.
snippetManager.getSession(bufnr: number): SnippetSession | undefined| Parameter | Type |
|---|---|
| bufnr | number |
Resolve snippet string to text.
snippetManager.resolveSnippet(body: string, ultisnip?: UltiSnippetOption): Promise<string>| Parameter | Type |
|---|---|
| body | string |
| ultisnip? | UltiSnippetOption |
Insert snippet to specific buffer, ultisnips not supported, and the placeholder is not selected.
snippetManager.insertBufferSnippet(bufnr: number, snippet: string | SnippetString, range: Range, insertTextMode?: InsertTextMode): Promise<boolean>| Parameter | Type | Description |
|---|---|---|
| bufnr | number | Buffer number for snippet to insert. |
| snippet | string | SnippetString | Textmate snippet or snippet string. |
| range | Range | Range to replace. |
| insertTextMode? | InsertTextMode | The insert text mode. |
Whether the snippet is activated.
Insert snippet to current buffer.
snippetManager.insertSnippet(snippet: string | SnippetString, select?: boolean, range?: Range, insertTextMode?: InsertTextMode, ultisnip?: UltiSnippetOption): Promise<boolean>| Parameter | Type | Description |
|---|---|---|
| snippet | string | SnippetString | Textmate snippet string. |
| select? | boolean | Not select first placeholder when false, default |
| range? | Range | Replace range, insert to current cursor position when undefined. |
| insertTextMode? | InsertTextMode | The insert text mode. |
| ultisnip? | UltiSnippetOption | Option of UltiSnips snippet. |
Whether the snippet is activated.
Insert multiple snippets to a specific buffer, the buffer must be attached buffer. The buffer could be hidden, ranges of inserted snippets should not have overlap, snippets are inserted as nested snippets of a top snippet. No ultisnip snippet support, selection is disabled by default. When not selected, the first placeholder is selected on BufEnter event.
snippetManager.insertBufferSnippets(bufnr: number, edits: SnippetEdit[], select?: boolean): Promise<boolean>| Parameter | Type | Description |
|---|---|---|
| bufnr | number | Buffer number of attached buffer. |
| edits | SnippetEdit[] | snippet edits with range and snippet. |
| select? | boolean |
True when snippet is activated.
Jump to next placeholder, only works when snippet session activated.
snippetManager.nextPlaceholder(): Promise<void>Jump to previous placeholder, only works when snippet session activated.
snippetManager.previousPlaceholder(): Promise<void>Cancel snippet session of current buffer, does nothing when no session activated.
snippetManager.cancel(): voidCheck if snippet activated for bufnr.
snippetManager.isActivated(bufnr: number): boolean| Parameter | Type |
|---|---|
| bufnr | number |