Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Workspace

A workspace.

Hierarchy

  • Disposable
  • EventEmitter
    • Workspace

Implemented by

Index

Properties

Methods

Properties

Readonly configSource

configSource: WorkspaceConfigSource

Gets the config source of that workspace.

Readonly folder

folder: WorkspaceFolder

The underlying folder.

Readonly onDidChangeConfiguration

onDidChangeConfiguration: (e: ConfigurationChangeEvent) => void | PromiseLike<void>

Is invoked when the configuration for that workspace changed.

Type declaration

    • (e: ConfigurationChangeEvent): void | PromiseLike<void>

    • Parameters

      • e: ConfigurationChangeEvent

      Returns void | PromiseLike<void>

Readonly rootPath

rootPath: string

Gets the root path of that workspace.

Methods

addListener

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

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns Workspace

dispose

  • dispose(): any

  • Dispose this object.

    Returns any

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

listenerCount

  • listenerCount(event: string | symbol): number

  • Parameters

    • event: string | symbol

    Returns number

listeners

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

  • Parameters

    • event: string | symbol

    Returns Function[]

off

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

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns Workspace

on

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

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns Workspace

once

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

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns Workspace

prependListener

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

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns Workspace

prependOnceListener

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

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns Workspace

rawListeners

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

  • Parameters

    • event: string | symbol

    Returns Function[]

removeAllListeners

  • removeAllListeners(event?: string | symbol): Workspace

  • Parameters

    • Optional event: string | symbol

    Returns Workspace

removeListener

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

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns Workspace

setMaxListeners

  • Parameters

    • n: number

    Returns Workspace

Generated using TypeDoc