Class Operator

Hierarchy

Operator

Index

Constructors

Properties

_builtIn _config isRemote pluginName

Accessors

config label name unlisted uri

Methods

execute needsOutput needsOutputResolution needsResolution needsUserInput resolveInput resolveOutput resolvePlacement useHooks fromJSON fromRemoteJSON

Constructors

constructor

new Operator(pluginName: string, _builtIn?: boolean, _config?: OperatorConfig): Operator
Parameters
- pluginName: string
- _builtIn: boolean = false
- _config: OperatorConfig = null
Returns Operator
- Defined in packages/operators/src/operators.ts:280

Properties

_builtIn

_builtIn: boolean = false

_config

_config: OperatorConfig = null

isRemote

isRemote: boolean = false

pluginName

pluginName: string

Accessors

config

get config(): OperatorConfig
Returns OperatorConfig
- Defined in packages/operators/src/operators.ts:288

label

get label(): string
Returns string
- Defined in packages/operators/src/operators.ts:294

name

get name(): string
Returns string
- Defined in packages/operators/src/operators.ts:291

unlisted

get unlisted(): boolean
Returns boolean
- Defined in packages/operators/src/operators.ts:300

uri

get uri(): string
Returns string
- Defined in packages/operators/src/operators.ts:297

Methods

execute

execute(ctx: ExecutionContext): Promise<void>
Parameters
- ctx: ExecutionContext
Returns Promise<void>
- Defined in packages/operators/src/operators.ts:349

needsOutput

needsOutput(ctx: ExecutionContext, result: OperatorResult): Promise<boolean>
Parameters
- ctx: ExecutionContext
- result: OperatorResult
Returns Promise<boolean>
- Defined in packages/operators/src/operators.ts:313

needsOutputResolution

needsOutputResolution(): boolean
Returns boolean
- Defined in packages/operators/src/operators.ts:310

needsResolution

needsResolution(): boolean
Returns boolean
- Defined in packages/operators/src/operators.ts:307

needsUserInput

needsUserInput(ctx: ExecutionContext): Promise<boolean>
Parameters
- ctx: ExecutionContext
Returns Promise<boolean>
- Defined in packages/operators/src/operators.ts:303

resolveInput

resolveInput(ctx: ExecutionContext): Promise<Property>
Parameters
- ctx: ExecutionContext
Returns Promise<Property>
- Defined in packages/operators/src/operators.ts:330

resolveOutput

resolveOutput(ctx: ExecutionContext, result: OperatorResult): Promise<Property>
Parameters
- ctx: ExecutionContext
- result: OperatorResult
Returns Promise<Property>
- Defined in packages/operators/src/operators.ts:338

resolvePlacement

resolvePlacement(): Promise<void | Placement>
Returns Promise<void | Placement>
- Defined in packages/operators/src/operators.ts:346

useHooks

useHooks(): object
Returns object
- Defined in packages/operators/src/operators.ts:326

`Static` fromJSON

fromJSON(json: {
    _builtin: boolean;
    config: object;
    plugin_name: string;
}): Operator
Parameters
- json: {
      _builtin: boolean;
      config: object;
      plugin_name: string;
  }
  - _builtin: boolean
  - config: object
  - plugin_name: string
Returns Operator
- Defined in packages/operators/src/operators.ts:359

`Static` fromRemoteJSON

fromRemoteJSON(json: object): Operator
Parameters
- json: object
Returns Operator
- Defined in packages/operators/src/operators.ts:354

Generated using TypeDoc