Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Neovim

Neovim API

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new Neovim(__namedParameters: object): Neovim

Properties

Buffer

Buffer: Buffer = Buffer

Tabpage

Tabpage: Tabpage = Tabpage

Window

Window: Window = Window

Protected _isReady

_isReady: Promise<boolean>

Protected client

client: any

data

data: Buffer | Number

logger

logger: ILogger

Protected prefix

prefix: string = "nvim_"

Protected transport

transport: Transport

Static defaultMaxListeners

defaultMaxListeners: number

Accessors

apiInfo

  • get apiInfo(): Promise<[number, ApiInfo]>

buffer

buffers

  • get buffers(): Promise<Buffer[]>

chans

  • get chans(): Promise<number[]>

colorMap

  • get colorMap(): Promise<object>

commands

  • get commands(): Promise<Object>

dir

  • set dir(dir: string): void

  • Set current directory

    Parameters

    • dir: string

    Returns void

line

  • get line(): string | Promise<string>
  • set line(line: string | Promise<string>): void

  • Get current line. Always returns a Promise.

    Returns string | Promise<string>

  • Set current line

    Parameters

    • line: string | Promise<string>

    Returns void

mode

  • get mode(): Promise<object>

runtimePaths

  • get runtimePaths(): Promise<string[]>

  • Get list of all runtime paths

    Returns Promise<string[]>

tabpage

tabpages

  • get tabpages(): Promise<Tabpage[]>

uis

  • get uis(): Promise<any[]>

window

windows

  • get windows(): Promise<Window[]>

Methods

__computed

  • __computed(name: string, args?: any[]): Promise<any>

_getArgsByPrefix

  • _getArgsByPrefix(...args: any[]): this[]

addListener

  • addListener(event: string | symbol, listener: Function): this

  • Parameters

    • event: string | symbol
    • listener: Function

    Returns this

call

callAtomic

  • callAtomic(calls: Array<VimValue>): Promise<[Array<any>, boolean]>

callDictFunction

  • callDictFunction(dict: object, fname: string, args?: VimValue | Array<VimValue>): object

callFunction

command

  • command(arg: string): Promise<any>

  • Runs a vim command

    Parameters

    • arg: string

    Returns Promise<any>

commandOutput

  • commandOutput(arg: string): Promise<string>

  • Runs a command and returns output (synchronous?)

    Parameters

    • arg: string

    Returns Promise<string>

deleteCurrentLine

  • deleteCurrentLine(): Promise<any>

deleteVar

  • deleteVar(name: string): Promise<void>

emit

  • emit(event: string | symbol, ...args: any[]): boolean

  • Parameters

    • event: string | symbol
    • Rest ...args: any[]

    Returns boolean

equals

errWrite

  • errWrite(str: string): Promise<any>

  • Write to error buffer

    Parameters

    • str: string

    Returns Promise<any>

errWriteLine

  • errWriteLine(str: string): Promise<any>

  • Write to error buffer

    Parameters

    • str: string

    Returns Promise<any>

eval

  • Evaluates a VimL expression (:help expression). Dictionaries and Lists are recursively expanded. On VimL error: Returns a generic error; v:errmsg is not updated.

    Parameters

    • expr: string

    Returns Promise<VimValue>

eventNames

  • eventNames(): (string | symbol)[]

  • Returns (string | symbol)[]

executeLua

  • executeLua(code: string, args?: Array<VimValue>): Promise<any>

feedKeys

  • feedKeys(keys: string, mode: string, escapeCsi: boolean): Promise<any>

  • feedKeys

    Parameters

    • keys: string
    • mode: string
    • escapeCsi: boolean

    Returns Promise<any>

getChanInfo

  • getChanInfo(chan: number): Promise<any>

getColorByName

  • getColorByName(name: string): Promise<number>

  • Get color by name

    Parameters

    • name: string

    Returns Promise<number>

getCommands

  • getCommands(options?: object): Promise<Object>

  • Parameters

    • Default value options: object = {}

    Returns Promise<Object>

getHighlight

  • getHighlight(nameOrId: string | number, isRgb?: boolean): Promise<any> | void

  • Get highlight by name or id

    Parameters

    • nameOrId: string | number
    • Default value isRgb: boolean = true

    Returns Promise<any> | void

getHighlightById

  • getHighlightById(id: number, isRgb?: boolean): Promise<any>

  • Parameters

    • id: number
    • Default value isRgb: boolean = true

    Returns Promise<any>

getHighlightByName

  • getHighlightByName(name: string, isRgb?: boolean): Promise<any>

  • Parameters

    • name: string
    • Default value isRgb: boolean = true

    Returns Promise<any>

getKeymap

  • getKeymap(mode: string): Promise<Array<any>>

  • Gets keymap

    Parameters

    • mode: string

    Returns Promise<Array<any>>

getLine

  • getLine(): Promise<string>

getMaxListeners

  • getMaxListeners(): number

  • Returns number

getOption

  • getOption(name: string): Promise<VimValue> | void

getProc

  • getProc(pid: number): Promise<Proc>

getProcChildren

  • getProcChildren(pid: number): Promise<Proc[]>

getVar

  • getVar(name: string): Promise<VimValue>

getVvar

  • getVvar(name: string): Promise<VimValue>

getWindow

getWindows

  • getWindows(): Promise<Window[]>

input

  • input(keys: string): Promise<number>

  • Sends input keys

    Parameters

    • keys: string

    Returns Promise<number>

listenerCount

  • listenerCount(type: string | symbol): number

  • Parameters

    • type: string | symbol

    Returns number

listeners

  • listeners(event: string | symbol): Function[]

  • Parameters

    • event: string | symbol

    Returns Function[]

lua

  • lua(code: string, args?: Array<VimValue>): Promise<any>

  • Executes lua, it's possible neovim client does not support this

    Parameters

    • code: string
    • Default value args: Array<VimValue> = []

    Returns Promise<any>

notify

  • notify(name: string, args: any[]): void

  • request is basically the same except you can choose to wait forpromise to be resolved

    Parameters

    • name: string
    • args: any[]

    Returns void

on

  • on(event: string | symbol, listener: Function): this

  • Parameters

    • event: string | symbol
    • listener: Function

    Returns this

once

  • once(event: string | symbol, listener: Function): this

  • Parameters

    • event: string | symbol
    • listener: Function

    Returns this

outWrite

  • outWrite(str: string): Promise<any>

  • Write to output buffer

    Parameters

    • str: string

    Returns Promise<any>

outWriteLine

  • outWriteLine(str: string): Promise<any>

parseExpression

  • parseExpression(expr: string, flags: string, highlight: boolean): Promise<any>

  • Parse a VimL Expression

    TODO: return type, see :help

    Parameters

    • expr: string
    • flags: string
    • highlight: boolean

    Returns Promise<any>

prependListener

  • prependListener(event: string | symbol, listener: Function): this

  • Parameters

    • event: string | symbol
    • listener: Function

    Returns this

prependOnceListener

  • prependOnceListener(event: string | symbol, listener: Function): this

  • Parameters

    • event: string | symbol
    • listener: Function

    Returns this

quit

  • quit(): void

removeAllListeners

  • removeAllListeners(event?: string | symbol): this

  • Parameters

    • Optional event: string | symbol

    Returns this

removeListener

  • removeListener(event: string | symbol, listener: Function): this

  • Parameters

    • event: string | symbol
    • listener: Function

    Returns this

replaceTermcodes

  • replaceTermcodes(str: string, fromPart: boolean, doIt: boolean, special: boolean): Promise<string>

  • Replace term codes

    Parameters

    • str: string
    • fromPart: boolean
    • doIt: boolean
    • special: boolean

    Returns Promise<string>

request

  • request(name: string, args?: any[]): Promise<any>

setClientInfo

  • setClientInfo(name: string, version: object, type: string, methods: object, attributes: object): void

  • Parameters

    • name: string
    • version: object
    • type: string
    • methods: object
    • attributes: object

    Returns void

setLine

  • setLine(line: string): Promise<any>

  • Set current line

    Parameters

    • line: string

    Returns Promise<any>

setMaxListeners

  • setMaxListeners(n: number): this

  • Parameters

    • n: number

    Returns this

setOption

  • setOption(name: string, value: VimValue): Promise<void> | void

Protected setTransport

setVar

  • setVar(name: string, value: VimValue): Promise<void>

setWindow

  • setWindow(win: Window): Promise<any>

strWidth

  • strWidth(str: string): Promise<number>

  • Gets width of string

    Parameters

    • str: string

    Returns Promise<number>

subscribe

  • subscribe(event: string): Promise<void>

  • Subscribe to nvim event broadcasts

    Parameters

    • event: string

    Returns Promise<void>

uiAttach

  • uiAttach(width: number, height: number, options: UiAttachOptions): Promise<void>

uiDetach

  • uiDetach(): Promise<void>

uiSetOption

  • uiSetOption(name: string, value: any): Promise<void>

  • Set UI Option

    Parameters

    • name: string
    • value: any

    Returns Promise<void>

uiTryResize

  • uiTryResize(width: number, height: number): Promise<void>

  • Parameters

    • width: number
    • height: number

    Returns Promise<void>

unsubscribe

  • unsubscribe(event: string): Promise<void>

  • Unsubscribe to nvim event broadcasts

    Parameters

    • event: string

    Returns Promise<void>

Static listenerCount

  • listenerCount(emitter: EventEmitter, event: string | symbol): number

  • Parameters

    • emitter: EventEmitter
    • event: string | symbol

    Returns number

Generated using TypeDoc