Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface JobScriptModuleExecutorArguments

The arguments for a job tick.

Hierarchy

Index

Properties

Properties

activate

activate: function

Activates the job.

param

The delay in milliseconds.

chainable

Type declaration

appState

appState: Memento

Gets the extension's Memento for accessing app wide data.

cached

cached: boolean

Gets or sets the value that indicates to cache the underlying script or not.

counter

counter: number

Gets or sets the counter that indicates how often the job has been executed.

deactivate

deactivate: function

Deactivates the job.

param

The delay in milliseconds.

chainable

Type declaration

deploy

deploy: function

Deploys one or more file to a list of targets.

This requires 'extension.deploy.filesTo' command as available in extensions like 'vs-deploy' s. https://github.com/mkloubert/vs-deploy

param

One or more file to deploy.

param

One or more target (name) to deploy to.

returns

The promise.

Type declaration

    • (files: string | string[], targets: string | string[]): Promise<any>

    • Parameters

      • files: string | string[]
      • targets: string | string[]

      Returns Promise<any>

description

description: string

Gets or sets the description for the underlying job.

detail

detail: string

Gets or sets the detail information for the GUI.

emit

emit: function

Emits an event.

param

The event to emit.

param

Additional arguments for the event.

returns

Event was emitted or not.

Type declaration

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

    • Parameters

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

      Returns boolean

globalState

globalState: Object

Gets an object that stores data for all scripts.

globals

globals: any

The global data from the settings.

isActive

isActive: boolean

Gets if the underlying job is active or not.

isRunning

isRunning: boolean

Gets if the underlying job is currently running or not.

lastExecution

lastExecution: Moment.Moment

Gets the timestamp of the previous execution.

log

log: function

Logs a message.

param

The message to log.

chainable

Type declaration

maximum

maximum: number

Gets or sets the maximum value that indicates how often the job can be executed.

minimum

minimum: number

Gets or sets the minumum value that how many ticks have to been made before the job can be executed.

name

name: string

Gets or sets the name of the underlying job.

nextValue

nextValue: any

Gets or sets the value for the next execution.

on

on: function

Registers for an event.

param

The event to register for.

param

The event listener.

chainable

Type declaration

once

once: function

Registers for an one-time event.

param

The event to register for.

param

The event listener.

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): Thenable<any>

    • Parameters

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

      Returns Thenable<any>

options

options: any

Additional / optional data for the execution.

outputChannel

outputChannel: OutputChannel

Gets the output channel the script can use.

packageFile

packageFile: PackageFile

The package file with the information about this extension.

previousValue

previousValue: any

Gets the value from the previous execution.

removeListener

removeListener: function

Registers for an one-time event.

param

The event to register for.

param

The event listener.

chainable

Type declaration

require

require: function

Loads a module from the script context.

param

The ID of the module.

returns

any The loaded module.

Type declaration

    • (id: string): any

    • Parameters

      • id: string

      Returns any

runParallel

runParallel: boolean

Gets or sets the value that indicates if this job can ran parallel to another or not.

script

script: string

Gets the script that is currently executed or sets it for the next execution.

start

start: function

Starts the underlying job.

param

The delay in milliseconds.

returns

The promise.

Type declaration

    • (delay?: number): Thenable<boolean>

    • Parameters

      • Optional delay: number

      Returns Thenable<boolean>

state

state: any

Gets or sets a value for the script that is available while the current session.

stop

stop: function

Stops the underlying job.

param

The delay in milliseconds.

returns

The promise.

Type declaration

    • (delay?: number): Thenable<boolean>

    • Parameters

      • Optional delay: number

      Returns Thenable<boolean>

subscriptions

subscriptions: object[]

Gets the array to which disposables can be added for this extension.

Type declaration

  • dispose: function
    • dispose(): any

    • Returns any

timeZone

timeZone: string

Gets or sets the current timezone.

validFrom

validFrom: Moment.MomentInput

Gets or sets the value that indicates the minimum time the job can be executed.

validUntil

validUntil: Moment.MomentInput

Gets or sets the value that indicates the maximum time the job can be executed.

workspaceState

workspaceState: Memento

Gets the extension's Memento for accessing workspace wide data.

Generated using TypeDoc