Skip to main content

LocalRunnerParameters

@webda/async

Class: LocalRunnerParameters

Defined in: packages/async/src/services/localrunner.service.ts:9

LocalRunner parameters

Extends​

Constructors​

Constructor​

new LocalRunnerParameters(): LocalRunnerParameters

Returns​

LocalRunnerParameters

Inherited from​

RunnerParameters.constructor

Properties​

actions?​

optional actions?: string[]

Defined in: packages/async/src/services/runner.service.ts:14

Actions managed by the runner

Default​

[]

Inherited from​

RunnerParameters.actions

args?​

optional args?: string[]

Defined in: packages/async/src/services/localrunner.service.ts:17

Args

autoStatus?​

optional autoStatus?: boolean

Defined in: packages/async/src/services/localrunner.service.ts:27

Use the observability of ChildProcess to update status accordingly

command​

command: string

Defined in: packages/async/src/services/localrunner.service.ts:13

Command to launch

options?​

optional options?: SpawnOptions

Defined in: packages/async/src/services/localrunner.service.ts:23

Options

Based on https://nodejs.org/api/child_process.html#child_process_child_process_spawn_command_args_options

type​

type: string

Defined in: packages/core/lib/services/serviceparameters.d.ts:8

Type of the service

Inherited from​

RunnerParameters.type

Methods​

load()​

load(params?): this

Defined in: packages/async/src/services/localrunner.service.ts:34

Parameters​

params?​

any = {}

the input parameters

Returns​

this

this

Overrides​

RunnerParameters.load

update()​

update(params, delta): this

Defined in: packages/core/lib/services/serviceparameters.d.ts:25

Update parameters and call watchers if a parameter was changed

Parameters​

params​

any

the service parameters

delta​

any

the delta

Returns​

this

this for chaining

Inherited from​

RunnerParameters.update

with()​

with(callback): this

Defined in: packages/core/lib/services/serviceparameters.d.ts:31

Watch for changes on the parameters and call watchers when a parameter is changed

Parameters​

callback​

(params) => void

the callback function

Returns​

this

this for chaining

Inherited from​

RunnerParameters.with