Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UserScript

Hierarchy

  • UserScript

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Optional Readonly argumentDefault

argumentDefault?: string

Optional Readonly argumentDescription

argumentDescription?: string

Readonly arrayStarted

arrayStarted: boolean = false

Readonly backgroundOnly

backgroundOnly: boolean = false

Readonly clearLog

clearLog: boolean = false

Optional Readonly description

description?: string

Readonly dirName

dirName: string

Readonly foregroundOnly

foregroundOnly: boolean = false

Readonly interpreter

interpreter: string = '/bin/bash'

Readonly name

name: string

Readonly noParity

noParity: boolean = false

Optional Readonly schedule

schedule?: Schedule

Readonly script

script: string

Methods

abort

  • abort(): Promise<void>

running

  • running(byPassCache?: boolean): Promise<boolean>

start

  • Start the userscript in foreground mode

    Parameters

    • Optional inputParameterCallback: (description: string, defaultValue?: string) => Promise<string>

      This callback gets called if an argument for the script is required

        • (description: string, defaultValue?: string): Promise<string>

        • Parameters

          • description: string
          • Optional defaultValue: string

          Returns Promise<string>

    Returns Promise<[EventEmitter, CancelFunction, Promise<IExecuteStreamResult>]>

startBackground

  • startBackground(): Promise<void>

Generated using TypeDoc