Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ScriptArguments

Arguments for a method in a script module.

Hierarchy

Index

Properties

Properties

globalState

globalState: Object

Gets the object to share data between all scripts of this type.

globals

globals: any

Gets the global data from the settings.

log

log: function

Logs a message.

param

The message to log.

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

    • Parameters

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

      Returns PromiseLike<any>

options

options: any

Options for the execution.

require

require: function

Loads a module from the script / extension context.

Type declaration

    • (id: string): any

    • Parameters

      • id: string

      Returns any

state

state: any

Stores a permanent value for the current session for THIS script.

whiteboard

whiteboard: WhiteboardRepository

Gets the underlying whiteboard (repository).

workspaceState

workspaceState: Object

Gets the workspace wide object to share data, between ALL scripts e.g.

Generated using TypeDoc