Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Buffer

Hierarchy

Index

Constructors

constructor

  • new Buffer(__namedParameters: object): Buffer

Properties

Protected _isReady

_isReady: Promise<boolean>

Protected client

client: any

data

data: Buffer | Number

Private isAttached

isAttached: boolean = false

logger

logger: ILogger

prefix

prefix: string = Metadata[ExtType.Buffer].prefix

Protected transport

transport: Transport

Static defaultMaxListeners

defaultMaxListeners: number

Accessors

changedtick

  • get changedtick(): Promise<number>
  • Gets a changed tick of a buffer

    Returns Promise<number>

commands

  • get commands(): Promise<Object>

id

  • get id(): number

length

  • get length(): Promise<number>
  • Total number of lines in buffer

    Returns Promise<number>

lines

  • get lines(): Promise<Array<string>>
  • Get lines in buffer

    Returns Promise<Array<string>>

name

  • get name(): string | Promise<string>
  • set name(value: string | Promise<string>): void
  • Get buffer name

    Returns string | Promise<string>

  • Set current buffer name

    Parameters

    • value: string | Promise<string>

    Returns void

valid

  • get valid(): Promise<boolean>

Methods

__computed

  • __computed(sendBuffer?: boolean, options?: __type): Promise<any>
  • __computed(): Promise<any>
  • Attach to buffer to listen to buffer events Detach from buffer to stop listening to buffer events

    Parameters

    • Default value sendBuffer: boolean = false

      Set to true if the initial notification should contain the whole buffer. If so, the first notification will be a nvim_buf_lines_event. Otherwise, the first notification will be a nvim_buf_changedtick_event

    • Default value options: __type = {}

    Returns Promise<any>

  • Attach to buffer to listen to buffer events Detach from buffer to stop listening to buffer events

    Returns Promise<any>

_getArgsByPrefix

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

addHighlight

  • addHighlight(__namedParameters: object): Promise<number>
  • Adds a highlight to buffer.

    This can be used for plugins which dynamically generate highlights to a buffer (like a semantic highlighter or linter). The function adds a single highlight to a buffer. Unlike matchaddpos() highlights follow changes to line numbering (as lines are inserted/removed above the highlighted line), like signs and marks do.

    "src_id" is useful for batch deletion/updating of a set of highlights. When called with src_id = 0, an unique source id is generated and returned. Succesive calls can pass in it as "src_id" to add new highlights to the same source group. All highlights in the same group can then be cleared with nvim_buf_clear_highlight. If the highlight never will be manually deleted pass in -1 for "src_id".

    If "hl_group" is the empty string no highlight is added, but a new src_id is still returned. This is useful for an external plugin to synchrounously request an unique src_id at initialization, and later asynchronously add and clear highlights in response to buffer changes.

    Parameters

    • __namedParameters: object
      • _end: number
      • _hlGroup: string
      • _srcId: number
      • _start: number
      • line: number

    Returns Promise<number>

addListener

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

    • event: string | symbol
    • listener: Function

    Returns this

append

  • append(lines: Array<string> | string): Promise<any>
  • Append a string or list of lines to end of buffer

    Parameters

    • lines: Array<string> | string

    Returns Promise<any>

clearHighlight

  • Clears highlights from a given source group and a range of lines

    To clear a source group in the entire buffer, pass in 1 and -1 to lineStart and lineEnd respectively.

    Parameters

    Returns 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

eventNames

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

getCommands

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

    • Default value options: object = {}

    Returns Promise<Object>

getKeymap

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

    Parameters

    • mode: string

    Returns Promise<Array<any>>

getLines

  • getLines(__namedParameters?: object): Promise<Array<string>>
  • Get specific lines of buffer

    Parameters

    • Default value __namedParameters: object = { start: 0, end: -1, strictIndexing: true }
      • end: number
      • start: number
      • strictIndexing: boolean

    Returns Promise<Array<string>>

getMaxListeners

  • getMaxListeners(): number
  • Returns number

getOption

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

getVar

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

insert

  • insert(lines: Array<string> | string, start: number): Promise<any>
  • Insert lines at start index

    Parameters

    • lines: Array<string> | string
    • start: number

    Returns Promise<any>

listen

  • listen(eventName: string, cb: Function): Function
  • Listens to buffer for events

    Parameters

    • eventName: string
    • cb: Function

    Returns Function

listenerCount

  • listenerCount(type: string | symbol): number
  • Parameters

    • type: string | symbol

    Returns number

listeners

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

    • event: string | symbol

    Returns Function[]

mark

  • mark(name: string): Promise<[number, number]>
  • Get mark position given mark name

    Parameters

    • name: string

    Returns Promise<[number, number]>

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

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

remove

  • remove(start: number, end: number, strictIndexing: boolean): Promise<any>
  • Remove lines at index

    Parameters

    • start: number
    • end: number
    • strictIndexing: boolean

    Returns Promise<any>

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

replace

  • replace(_lines: Array<string> | string, start: number): Promise<any>
  • Replace lines starting at start index

    Parameters

    • _lines: Array<string> | string
    • start: number

    Returns Promise<any>

request

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

setLines

  • setLines(_lines: string | string[], __namedParameters?: object): Promise<any>
  • Set lines of buffer given indeces

    Parameters

    • _lines: string | string[]
    • Default value __namedParameters: object = {strictIndexing: true,}
      • _end: number
      • _start: number
      • strictIndexing: boolean

    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>

unlisten

  • unlisten(eventName: string, cb: Function): void
  • Parameters

    • eventName: string
    • cb: Function

    Returns void

Static listenerCount

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

    • emitter: EventEmitter
    • event: string | symbol

    Returns number

Generated using TypeDoc