ReadLine | typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Properties

Static defaultMaxListeners

defaultMaxListeners: number

Methods

addListener

  • addListener(event: string, listener: Function): this
  • addListener(event: "close", listener: function): this
  • addListener(event: "line", listener: function): this
  • addListener(event: "pause", listener: function): this
  • addListener(event: "resume", listener: function): this
  • addListener(event: "SIGCONT", listener: function): this
  • addListener(event: "SIGINT", listener: function): this
  • addListener(event: "SIGTSTP", listener: function): this
  • events.EventEmitter

    1. close
    2. line
    3. pause
    4. resume
    5. SIGCONT
    6. SIGINT
    7. SIGTSTP

    Parameters

    • event: string
    • listener: Function

    Returns this

  • Parameters

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

    Returns this

  • Parameters

    • event: "line"
    • listener: function
        • (input: any): void
        • Parameters

          • input: any

          Returns void

    Returns this

  • Parameters

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

    Returns this

  • Parameters

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

    Returns this

  • Parameters

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

    Returns this

  • Parameters

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

    Returns this

  • Parameters

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

    Returns this

close

  • close(): void
  • Returns void

emit

  • emit(event: string | symbol, ...args: any[]): boolean
  • emit(event: "close"): boolean
  • emit(event: "line", input: any): boolean
  • emit(event: "pause"): boolean
  • emit(event: "resume"): boolean
  • emit(event: "SIGCONT"): boolean
  • emit(event: "SIGINT"): boolean
  • emit(event: "SIGTSTP"): boolean
  • Parameters

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

    Returns boolean

  • Parameters

    • event: "close"

    Returns boolean

  • Parameters

    • event: "line"
    • input: any

    Returns boolean

  • Parameters

    • event: "pause"

    Returns boolean

  • Parameters

    • event: "resume"

    Returns boolean

  • Parameters

    • event: "SIGCONT"

    Returns boolean

  • Parameters

    • event: "SIGINT"

    Returns boolean

  • Parameters

    • event: "SIGTSTP"

    Returns boolean

eventNames

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

getMaxListeners

  • getMaxListeners(): number

listenerCount

  • listenerCount(type: string | symbol): number

listeners

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

    • event: string | symbol

    Returns Function[]

on

  • on(event: string, listener: Function): this
  • on(event: "close", listener: function): this
  • on(event: "line", listener: function): this
  • on(event: "pause", listener: function): this
  • on(event: "resume", listener: function): this
  • on(event: "SIGCONT", listener: function): this
  • on(event: "SIGINT", listener: function): this
  • on(event: "SIGTSTP", listener: function): this
  • Parameters

    • event: string
    • listener: Function

    Returns this

  • Parameters

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

    Returns this

  • Parameters

    • event: "line"
    • listener: function
        • (input: any): void
        • Parameters

          • input: any

          Returns void

    Returns this

  • Parameters

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

    Returns this

  • Parameters

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

    Returns this

  • Parameters

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

    Returns this

  • Parameters

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

    Returns this

  • Parameters

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

    Returns this

once

  • once(event: string, listener: Function): this
  • once(event: "close", listener: function): this
  • once(event: "line", listener: function): this
  • once(event: "pause", listener: function): this
  • once(event: "resume", listener: function): this
  • once(event: "SIGCONT", listener: function): this
  • once(event: "SIGINT", listener: function): this
  • once(event: "SIGTSTP", listener: function): this
  • Parameters

    • event: string
    • listener: Function

    Returns this

  • Parameters

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

    Returns this

  • Parameters

    • event: "line"
    • listener: function
        • (input: any): void
        • Parameters

          • input: any

          Returns void

    Returns this

  • Parameters

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

    Returns this

  • Parameters

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

    Returns this

  • Parameters

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

    Returns this

  • Parameters

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

    Returns this

  • Parameters

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

    Returns this

pause

  • pause(): this
  • Returns this

prependListener

  • prependListener(event: string, listener: Function): this
  • prependListener(event: "close", listener: function): this
  • prependListener(event: "line", listener: function): this
  • prependListener(event: "pause", listener: function): this
  • prependListener(event: "resume", listener: function): this
  • prependListener(event: "SIGCONT", listener: function): this
  • prependListener(event: "SIGINT", listener: function): this
  • prependListener(event: "SIGTSTP", listener: function): this
  • Parameters

    • event: string
    • listener: Function

    Returns this

  • Parameters

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

    Returns this

  • Parameters

    • event: "line"
    • listener: function
        • (input: any): void
        • Parameters

          • input: any

          Returns void

    Returns this

  • Parameters

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

    Returns this

  • Parameters

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

    Returns this

  • Parameters

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

    Returns this

  • Parameters

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

    Returns this

  • Parameters

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

    Returns this

prependOnceListener

  • prependOnceListener(event: string, listener: Function): this
  • prependOnceListener(event: "close", listener: function): this
  • prependOnceListener(event: "line", listener: function): this
  • prependOnceListener(event: "pause", listener: function): this
  • prependOnceListener(event: "resume", listener: function): this
  • prependOnceListener(event: "SIGCONT", listener: function): this
  • prependOnceListener(event: "SIGINT", listener: function): this
  • prependOnceListener(event: "SIGTSTP", listener: function): this
  • Parameters

    • event: string
    • listener: Function

    Returns this

  • Parameters

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

    Returns this

  • Parameters

    • event: "line"
    • listener: function
        • (input: any): void
        • Parameters

          • input: any

          Returns void

    Returns this

  • Parameters

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

    Returns this

  • Parameters

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

    Returns this

  • Parameters

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

    Returns this

  • Parameters

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

    Returns this

  • Parameters

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

    Returns this

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): this

removeListener

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

resume

  • resume(): this
  • Returns this

setMaxListeners

  • setMaxListeners(n: number): this

setPrompt

  • setPrompt(prompt: string): void
  • Parameters

    • prompt: string

    Returns void

write

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

    Returns void

Static listenerCount

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

    Returns 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