Options
All
  • Public
  • Public/Protected
  • All
Menu

Class BaseApi

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

  • new BaseApi(__namedParameters: object): BaseApi

  • Parameters

    • __namedParameters: object
      • client: any
      • data: Buffer
      • logger: LoggerInstance
      • metadata: any
      • transport: Transport

    Returns BaseApi

Properties

Protected _isReady

_isReady: Promise<boolean>

Protected client

client: any

data

data: Buffer | Number

logger

logger: ILogger

Protected prefix

prefix: string

Protected transport

transport: Transport

Static defaultMaxListeners

defaultMaxListeners: number

Methods

__computed

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

  • Parameters

    • name: string
    • Default value args: any[] = []

    Returns Promise<any>

_getArgsByPrefix

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

  • Parameters

    • Rest ...args: any[]

    Returns this[]

addListener

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

  • Parameters

    • event: string | symbol
    • listener: Function

    Returns this

deleteVar

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

  • Delete a scoped variable

    Parameters

    • name: string

    Returns 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

  • Retrieves a scoped option depending on type of this

    Parameters

    • name: string

    Returns Promise<VimValue> | void

getVar

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

  • Retrieves a scoped variable depending on type (using this.prefix)

    Parameters

    • name: string

    Returns 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>

  • Parameters

    • name: string
    • Default value args: any[] = []

    Returns Promise<any>

setMaxListeners

  • setMaxListeners(n: number): this

  • Parameters

    • n: number

    Returns this

setOption

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

  • Set scoped option

    Parameters

    Returns Promise<void> | void

Protected setTransport

setVar

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

Static listenerCount

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

  • Parameters

    • emitter: EventEmitter
    • event: string | symbol

    Returns number

Generated using TypeDoc