Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LocalPlugin

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Protected _DISPOSABLES

_DISPOSABLES: vscode.Disposable[]

Stores disposable sub objects.

Protected _INTERVALS

_INTERVALS: Timer[]

Stores intervals.

Protected _TIMEOUTS

_TIMEOUTS: Timer[]

Stores timeouts.

__file

__file: string

[INTERNAL] DO NOT DEFINE OR OVERWRITE THIS PROPERTY BY YOUR OWN!

Gets the filename of the plugin.

__filePath

__filePath: string

[INTERNAL] DO NOT DEFINE OR OVERWRITE THIS PROPERTY BY YOUR OWN!

Gets the full path of the plugin's file.

__index

__index: number

[INTERNAL] DO NOT DEFINE OR OVERWRITE THIS PROPERTY BY YOUR OWN!

Gets the index of the plugin.

__type

__type: string

[INTERNAL] DO NOT DEFINE OR OVERWRITE THIS PROPERTY BY YOUR OWN!

Gets the type of the plugin.

context

context: PluginContext

The underlying context.

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

canDelete

  • get canDelete(): boolean

canDownload

  • get canDownload(): boolean

canList

  • get canList(): boolean

canRemoveFolders

  • get canRemoveFolders(): boolean

canUpload

  • get canUpload(): boolean

Methods

addListener

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

  • Parameters

    • event: string | symbol
    • listener: Function

    Returns this

Protected cleanupIntervals

  • cleanupIntervals(): void

  • Cleansup all timeouts.

    Returns void

Protected cleanupTimeouts

  • cleanupTimeouts(): void

  • Cleansup all timeouts.

    Returns void

deleteFiles

dispose

  • dispose(): void

  • Dispose this object.

    Returns void

downloadFiles

emit

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

  • Parameters

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

    Returns boolean

eventNames

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

  • Returns (string | symbol)[]

Protected getCache

  • getCache(target: Target): CacheProvider

Protected getExistingSettingPath

  • getExistingSettingPath(target: Target, path: string): Promise<false | string>

  • Returns an existing path for a target, based on the settings folder.

    Parameters

    • target: Target

      The underlying target.

    • path: string

      The path.

    Returns Promise<false | string>

    The promise with the existing, full normalized path or (false) if path does not exist.

getMaxListeners

  • getMaxListeners(): number

  • Returns number

Private getTargetSettings

Protected getWorkspaceOfTarget

  • getWorkspaceOfTarget<TDefault>(target: Target, defaultValue?: TDefault): Workspace | TDefault

  • Returns the workspace of a target.

    Type parameters

    • TDefault

    Parameters

    • target: Target

      The target.

    • Optional defaultValue: TDefault

      The default value if workspace is not available.

    Returns Workspace | TDefault

    The workspace or the default value.

initialize

  • initialize(): Promise<void>

Protected isPathOf

  • isPathOf(target: Target, path: string): boolean

  • Checks if a path is part of the workspace of a target.

    Parameters

    • target: Target

      The underlying target.

    • path: string

      The path to check.

    Returns boolean

    Is part of workspace or not.

listDirectory

listenerCount

  • listenerCount(type: string | symbol): number

  • Parameters

    • type: string | symbol

    Returns number

listeners

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

  • Parameters

    • event: string | symbol

    Returns Function[]

Private normalizeDir

on

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

  • Parameters

    • event: string | symbol
    • listener: Function

    Returns this

Protected onDispose

  • onDispose(): void

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

    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

removeFolders

removeListener

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

  • Parameters

    • event: string | symbol
    • listener: Function

    Returns this

Protected replaceWithValues

  • replaceWithValues(target: Target, val: any, additionalValues?: Value | Value[]): string

setMaxListeners

  • setMaxListeners(n: number): this

  • Parameters

    • n: number

    Returns this

Protected t

  • t(target: Target, key: string, ...args: any[]): string

  • Returns a translated string by key and a target.

    Parameters

    • target: Target

      The underlying target.

    • key: string

      The key.

    • Rest ...args: any[]

    Returns string

    The "translated" string.

uploadFiles

Static listenerCount

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

  • Parameters

    • emitter: EventEmitter
    • event: string | symbol

    Returns number

Generated using TypeDoc