Options
All
  • Public
  • Public/Protected
  • All
Menu

Class WorkspaceBase

A basic workspace.

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • Initializes a new instance of that class.

    Parameters

    • folder: WorkspaceFolder

      The underlying folder.

    Returns WorkspaceBase

Properties

Protected Readonly _DISPOSABLES

_DISPOSABLES: Disposable[]

Stores disposable sub objects.

Protected Readonly _INTERVALS

_INTERVALS: Timer[]

Stores intervals.

Protected Readonly _TIMEOUTS

_TIMEOUTS: Timer[]

Stores timeouts.

Readonly folder

folder: WorkspaceFolder

The underlying folder.

Static Readonly captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

Static captureRejections

captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

Static defaultMaxListeners

defaultMaxListeners: number

Static Readonly errorMonitor

errorMonitor: typeof errorMonitor

This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

Installing a listener using this symbol does not change the behavior once an 'error' event is emitted, therefore the process will still crash if no regular 'error' listener is installed.

Accessors

Abstract configSource

isDisposed

  • get isDisposed(): boolean

  • Gets if object has been disposed or not.

    Returns boolean

isDisposing

  • get isDisposing(): boolean

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

    Returns boolean

isInFinalizeState

  • get isInFinalizeState(): boolean

  • Gets if the object is disposed or currently disposing.

    Returns boolean

rootPath

  • get rootPath(): string

  • Gets the root path of that workspace.

    Returns string

Methods

addListener

  • addListener(event: string | symbol, listener: (...args: any[]) => void): WorkspaceBase

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns WorkspaceBase

Protected cleanupIntervals

  • cleanupIntervals(): void

  • Cleansup all timeouts.

    Returns void

Protected cleanupTimeouts

  • cleanupTimeouts(): void

  • Cleansup all timeouts.

    Returns void

dispose

  • dispose(): void

emit

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

  • Parameters

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

    Returns boolean

eventNames

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

getMaxListeners

  • getMaxListeners(): number

listenerCount

  • listenerCount(event: string | symbol): number

listeners

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

off

  • off(event: string | symbol, listener: (...args: any[]) => void): WorkspaceBase

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns WorkspaceBase

on

  • on(event: string | symbol, listener: (...args: any[]) => void): WorkspaceBase

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns WorkspaceBase

onDidChangeConfiguration

  • onDidChangeConfiguration(e: ConfigurationChangeEvent): Promise<void>

  • Is invoked when the configuration for that workspace changed.

    inheritdoc

    Parameters

    • e: ConfigurationChangeEvent

    Returns Promise<void>

Protected onDispose

  • onDispose(): void

  • Additional logic for the 'dispose()' method.

    Returns void

once

  • once(event: string | symbol, listener: (...args: any[]) => void): WorkspaceBase

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns WorkspaceBase

prependListener

  • prependListener(event: string | symbol, listener: (...args: any[]) => void): WorkspaceBase

prependOnceListener

  • prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): WorkspaceBase

rawListeners

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

removeAllListeners

removeListener

  • removeListener(event: string | symbol, listener: (...args: any[]) => void): WorkspaceBase

setMaxListeners

Static listenerCount

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

    since v4.0.0

    Parameters

    • emitter: EventEmitter
    • event: string | symbol

    Returns number

Static on

  • on(emitter: EventEmitter, event: string): AsyncIterableIterator<any>

  • Parameters

    • emitter: EventEmitter
    • event: string

    Returns AsyncIterableIterator<any>

Static once

  • once(emitter: NodeEventTarget, event: string | symbol): Promise<any[]>
  • once(emitter: DOMEventTarget, event: string): Promise<any[]>

  • Parameters

    • emitter: NodeEventTarget
    • event: string | symbol

    Returns Promise<any[]>

  • Parameters

    • emitter: DOMEventTarget
    • event: string

    Returns Promise<any[]>

Generated using TypeDoc