Options
All
  • Public
  • Public/Protected
  • All
Menu

Class OutputChannelWrapper

A wrapper for an output channel.

Hierarchy

  • DisposableBase
    • OutputChannelWrapper

Implements

  • Disposable
  • OutputChannel

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new OutputChannelWrapper(baseChannel: vscode.OutputChannel, ownsChannel?: boolean): OutputChannelWrapper

  • Initializes a new instance of that class.

    Parameters

    • baseChannel: vscode.OutputChannel

      The base channel.

    • Optional ownsChannel: boolean

    Returns OutputChannelWrapper

Properties

Protected _DISPOSABLES

_DISPOSABLES: vscode.Disposable[]

Stores disposable sub objects.

Protected _INTERVALS

_INTERVALS: Timer[]

Stores intervals.

Private _OWNS_CHANNEL

_OWNS_CHANNEL: boolean

Protected _TIMEOUTS

_TIMEOUTS: Timer[]

Stores timeouts.

Private _WRITERS

_WRITERS: ChannelWriter[] = []

baseChannel

baseChannel: vscode.OutputChannel

The base channel.

isDisposed

isDisposed: boolean

Gets if object has been disposed or not.

isDisposing

isDisposing: boolean

Gets if the 'dispose()' method is currently executed or not.

isInFinalizeState

isInFinalizeState: boolean

Gets if the object is disposed or currently disposing.

Static defaultMaxListeners

defaultMaxListeners: number

Accessors

name

  • get name(): string

Methods

addListener

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

  • Parameters

    • event: string | symbol
    • listener: Function

    Returns this

addWriter

append

  • append(value: any): void
  • inheritdoc

    Parameters

    • value: any

    Returns void

appendLine

  • appendLine(value: any): void
  • inheritdoc

    Parameters

    • value: any

    Returns void

Protected cleanupIntervals

  • cleanupIntervals(): void

  • Cleansup all timeouts.

    Returns void

Protected cleanupTimeouts

  • cleanupTimeouts(): void

  • Cleansup all timeouts.

    Returns void

clear

  • clear(): void

dispose

  • dispose(): void
  • inheritdoc

    Returns void

emit

  • emit(event: string | symbol, ...args: any[]): boolean

  • Parameters

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

    Returns boolean

eventNames

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

  • Returns (string | symbol)[]

getMaxListeners

  • getMaxListeners(): number

  • Returns number

hide

  • hide(): void

Private invokeForBaseChannel

  • invokeForBaseChannel<TResult>(method: function, args?: IArguments | any[]): TResult

  • Type parameters

    • TResult

    Parameters

    • method: function
        • (...args: any[]): TResult

        • Parameters

          • Rest ...args: any[]

          Returns TResult

    • Optional args: IArguments | any[]

    Returns TResult

listenerCount

  • listenerCount(type: string | symbol): number

  • Parameters

    • type: string | symbol

    Returns number

listeners

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

  • Parameters

    • event: string | symbol

    Returns Function[]

on

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

  • Parameters

    • event: string | symbol
    • listener: Function

    Returns this

Protected onDispose

  • onDispose(): void
  • inheritdoc

    Returns void

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

Private sendToWriters

  • sendToWriters(text: string, addNewLine: boolean): void

  • Parameters

    • text: string
    • addNewLine: boolean

    Returns void

setMaxListeners

  • setMaxListeners(n: number): this

  • Parameters

    • n: number

    Returns this

show

  • show(): void

Static listenerCount

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

  • Parameters

    • emitter: EventEmitter
    • event: string | symbol

    Returns number

Generated using TypeDoc