Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DeployContext

A deploy context.

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

  • Creates a new Disposable calling the provided function on dispose.

    Parameters

    • callOnDispose: Function

      Function that disposes something.

    Returns DeployContext

Properties

config

config: function

Returns the current config.

returns

The current config.

Type declaration

emit

emit: function

Emits an event of the context.

param

The event.

param

The arguments.

Type declaration

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

    • Parameters

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

      Returns boolean

emitGlobal

emitGlobal: function

Emits a global event.

param

The event.

param

The arguments.

Type declaration

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

    • Parameters

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

      Returns boolean

error

error: function

Shows an error message.

param

The message to show.

chainable

Type declaration

globals

globals: function

Gets the list of global vars.

Type declaration

info

info: function

Shows an info message.

param

The message to show.

chainable

Type declaration

isActive

isActive: function

Returns if the underlying extension is currently active or not.

Type declaration

    • (): boolean

    • Returns boolean

isCancelling

isCancelling: function

Returns if cancellation has been requested or not.

returns

Cancellation has been requested or not.

Type declaration

    • (): boolean

    • Returns boolean

log

log: function

Logs a message.

param

The message to log.

chainable

Type declaration

once

once: function

Registers a callback for an event that is invoked once.

param

The event.

param

The callback to register.

chainable

Type declaration

openHtml

openHtml: function

Opens a HTML document in a new tab.

param

The HTML document (source code).

param

The custom title for the tab.

param

The custom ID for the document in the storage.

returns

The promise.

Type declaration

    • (html: string, title?: string, id?: any): Promise<any>

    • Parameters

      • html: string
      • Optional title: string
      • Optional id: any

      Returns Promise<any>

outputChannel

outputChannel: function

Gets the global output channel.

Type declaration

    • (): vscode.OutputChannel

    • Returns vscode.OutputChannel

packageFile

packageFile: function

Returns the package file of that extension.

returns

The data of the package file.

Type declaration

packages

packages: function

Returns the list of packages.

returns

The packages.

Type declaration

plugins

plugins: function

Returns the list of (other) plugins.

returns

The list of (other) plugins.

Type declaration

replaceWithValues

replaceWithValues: function

Handles a value as string and replaces placeholders.

param

The value to parse.

returns

The parsed value.

Type declaration

    • (val: any): string

    • Parameters

      • val: any

      Returns string

require

require: function

Loads a module from the extension context / directory.

param

The ID / path of the module.

returns

The module.

Type declaration

    • (id: string): any

    • Parameters

      • id: string

      Returns any

targetCache

targetCache: function

Returns the cache of the targets.

returns

The cache.

Type declaration

targets

targets: function

Returns the list of targets.

returns

The targets.

Type declaration

values

values: function

Returns the list of values.

Type declaration

warn

warn: function

Shows a warning message.

param

The message to show.

chainable

Type declaration

workspace

workspace: function

Returns the root directory of the current workspace.

returns

The root directory of the current workspace.

Type declaration

    • (): string

    • Returns string

write

write: function

Writes a messages to the output channel.

param

The message to write.

chainable

Type declaration

writeLine

writeLine: function

Writes a messages to the output channel and adds a new line.

param

The message to write.

chainable

Type declaration

Methods

deployFiles

dispose

  • dispose(): any

  • Dispose this object.

    Returns any

filterConditionalItems

  • filterConditionalItems<T>(items: T | T[]): T[]

Static from

  • from(...disposableLikes: object[]): Disposable

  • Combine many disposable-likes into one. Use this method when having objects with a dispose function which are not instances of Disposable.

    Parameters

    • Rest ...disposableLikes: object[]

      Objects that have at least a dispose-function member.

    Returns Disposable

    Returns a new disposable which, upon dispose, will dispose all provided disposables.

Generated using TypeDoc