Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AsyncWindow

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new AsyncWindow(__namedParameters: object): AsyncWindow

Properties

Promise

Promise: PromiseConstructor

__@toStringTag

__@toStringTag: "Promise"

Protected _isReady

_isReady: Promise<boolean>

Protected client

client: any

data

data: Buffer | Number

logger

logger: ILogger

prefix

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

Protected transport

transport: Transport

Static defaultMaxListeners

defaultMaxListeners: number

Accessors

buffer

col

  • get col(): Promise<number>

  • 0-indexed, on-screen window position(col) in display cells.

    Returns Promise<number>

cursor

  • get cursor(): [number, number] | Promise<[number, number]>
  • set cursor(pos: [number, number] | Promise<[number, number]>): void

  • Get cursor position

    Returns [number, number] | Promise<[number, number]>

  • Set cursor position

    Parameters

    • pos: [number, number] | Promise<[number, number]>

    Returns void

height

  • get height(): number | Promise<number>
  • set height(height: number | Promise<number>): void

id

  • get id(): number

number

  • get number(): Promise<number>

position

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

row

  • get row(): Promise<number>

  • 0-indexed, on-screen window position(row) in display cells.

    Returns Promise<number>

tabpage

valid

  • get valid(): Promise<boolean>

width

  • get width(): number | Promise<number>
  • set width(width: number | Promise<number>): void

  • Get window width by number of columns

    Returns number | Promise<number>

  • Set window width by number of columns

    Parameters

    • width: number | Promise<number>

    Returns void

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

catch

  • catch<TResult>(onrejected?: function | undefined | null): Promise<Window | TResult>

  • Attaches a callback for only the rejection of the Promise.

    Type parameters

    • TResult

    Parameters

    • Optional onrejected: function | undefined | null

      The callback to execute when the Promise is rejected.

    Returns Promise<Window | TResult>

    A Promise for the completion of the callback.

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)[]

getMaxListeners

  • getMaxListeners(): number

  • Returns number

getOption

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

getVar

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

listenerCount

  • listenerCount(type: string | symbol): number

  • Parameters

    • type: string | symbol

    Returns number

listeners

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

  • Parameters

    • event: string | symbol

    Returns Function[]

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

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

request

  • request(name: string, args?: any[]): 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>

then

  • then<TResult1, TResult2>(onfulfilled?: function | undefined | null, onrejected?: function | undefined | null): Promise<TResult1 | TResult2>

  • Attaches callbacks for the resolution and/or rejection of the Promise.

    Type parameters

    • TResult1

    • TResult2

    Parameters

    • Optional onfulfilled: function | undefined | null

      The callback to execute when the Promise is resolved.

    • Optional onrejected: function | undefined | null

      The callback to execute when the Promise is rejected.

    Returns Promise<TResult1 | TResult2>

    A Promise for the completion of which ever callback is executed.

Static listenerCount

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

  • Parameters

    • emitter: EventEmitter
    • event: string | symbol

    Returns number

Generated using TypeDoc