WebCola
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Properties

defaultMaxListeners

defaultMaxListeners: number

Methods

addListener

  • addListener(event: string, listener: Function)
  • addListener(event: "exit", listener: function)
  • addListener(event: "reset", listener: Function)
  • events.EventEmitter

    1. exit
    2. reset

    Parameters

    • event: string
    • listener: Function
  • Parameters

    • event: "exit"
    • listener: function
        • (): void
        • Returns void

  • Parameters

    • event: "reset"
    • listener: Function

close

  • close(): void
  • Returns void

defineCommand

  • defineCommand(keyword: string, cmd: Function | object): void
  • Parameters

    • keyword: string
    • cmd: Function | object

    Returns void

displayPrompt

  • displayPrompt(preserveCursor?: boolean): void
  • Parameters

    • Optional preserveCursor: boolean

    Returns void

emit

  • emit(event: string, ...args: any[]): boolean
  • emit(event: "exit"): boolean
  • emit(event: "reset", context: any): boolean
  • Parameters

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

    Returns boolean

  • Parameters

    • event: "exit"

    Returns boolean

  • Parameters

    • event: "reset"
    • context: any

    Returns boolean

eventNames

  • eventNames(): string | symbol

getMaxListeners

  • getMaxListeners(): number

listenerCount

  • listenerCount(type: string | symbol): number

listeners

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

on

  • on(event: string, listener: Function)
  • on(event: "exit", listener: function)
  • on(event: "reset", listener: Function)
  • Parameters

    • event: string
    • listener: Function
  • Parameters

    • event: "exit"
    • listener: function
        • (): void
        • Returns void

  • Parameters

    • event: "reset"
    • listener: Function

once

  • once(event: string, listener: Function)
  • once(event: "exit", listener: function)
  • once(event: "reset", listener: Function)
  • Parameters

    • event: string
    • listener: Function
  • Parameters

    • event: "exit"
    • listener: function
        • (): void
        • Returns void

  • Parameters

    • event: "reset"
    • listener: Function

pause

prependListener

  • prependListener(event: string, listener: Function)
  • prependListener(event: "exit", listener: function)
  • prependListener(event: "reset", listener: Function)
  • Parameters

    • event: string
    • listener: Function
  • Parameters

    • event: "exit"
    • listener: function
        • (): void
        • Returns void

  • Parameters

    • event: "reset"
    • listener: Function

prependOnceListener

  • prependOnceListener(event: string, listener: Function)
  • prependOnceListener(event: "exit", listener: function)
  • prependOnceListener(event: "reset", listener: Function)
  • Parameters

    • event: string
    • listener: Function
  • Parameters

    • event: "exit"
    • listener: function
        • (): void
        • Returns void

  • Parameters

    • event: "reset"
    • listener: Function

prompt

  • prompt(preserveCursor?: boolean): void
  • Parameters

    • Optional preserveCursor: boolean

    Returns void

question

  • question(query: string, callback: function): void
  • Parameters

    • query: string
    • callback: function
        • (answer: string): void
        • Parameters

          • answer: string

          Returns void

    Returns void

removeAllListeners

  • removeAllListeners(event?: string | symbol)

removeListener

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

resume

setMaxListeners

  • setMaxListeners(n: number)

setPrompt

  • setPrompt(prompt: string): void
  • Parameters

    • prompt: string

    Returns void

write

  • write(data: string | Buffer, key?: Key): void
  • Parameters

    Returns void

listenerCount

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

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc