Class NvimPlugin

Hierarchy

NvimPlugin

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new NvimPlugin(filename: string, plugin: any, nvim: Neovim): NvimPlugin

- Defined in host/NvimPlugin.ts:61
Parameters
- filename: string
- plugin: any
- nvim: Neovim
Returns NvimPlugin

Properties

alwaysInit

alwaysInit: boolean

autocmds

autocmds: object

Type declaration

[index: string]: Handler

commands

commands: object

Type declaration

[index: string]: Handler

dev

dev: boolean

filename

filename: string

functions

functions: object

Type declaration

[index: string]: Handler

instance

instance: any

nvim

nvim: Neovim

Accessors

shouldCacheModule

get shouldCacheModule(): boolean

- Defined in host/NvimPlugin.ts:91
Returns boolean

specs

get specs(): Spec[]

- Defined in host/NvimPlugin.ts:194
Returns Spec[]

Methods

handleRequest

handleRequest(name: string, type: string, args: any[]): Promise<any>

- Defined in host/NvimPlugin.ts:207
Parameters
- name: string
- type: string
- args: any[]
Returns Promise<any>

registerAutocmd

registerAutocmd(name: string, fn: Function, options: AutocmdOptions): void
registerAutocmd(name: string, fn: [any, Function], options: AutocmdOptions): void

- Defined in host/NvimPlugin.ts:95
Parameters
- name: string
- fn: Function
- options: AutocmdOptions
Returns void
- Defined in host/NvimPlugin.ts:96
Parameters
- name: string
- fn: [any, Function]
- options: AutocmdOptions
Returns void

registerCommand

registerCommand(name: string, fn: Function, options?: CommandOptions): void
registerCommand(name: string, fn: [any, Function], options?: CommandOptions): void

- Defined in host/NvimPlugin.ts:130
Parameters
- name: string
- fn: Function
- Optional options: CommandOptions
Returns void
- Defined in host/NvimPlugin.ts:131
Parameters
- name: string
- fn: [any, Function]
- Optional options: CommandOptions
Returns void

registerFunction

registerFunction(name: string, fn: Function, options?: NvimFunctionOptions): void
registerFunction(name: string, fn: [any, Function], options?: NvimFunctionOptions): void

- Defined in host/NvimPlugin.ts:160
Parameters
- name: string
- fn: Function
- Optional options: NvimFunctionOptions
Returns void
- Defined in host/NvimPlugin.ts:165
Parameters
- name: string
- fn: [any, Function]
- Optional options: NvimFunctionOptions
Returns void

setOptions

setOptions(options: NvimPluginOptions): void

- Defined in host/NvimPlugin.ts:85
Parameters
- options: NvimPluginOptions
Returns void

Generated using TypeDoc