Class TaskRef

Descriptor for task functionality and location

Hierarchy

AbstractRef
- TaskRef
  - NullTaskRef

Implements

IEntityRef

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new TaskRef(name: string | object | Function, fn?: object | Function, options?: ITaskRefOptions): TaskRef

Overrides AbstractRef.constructor
- Defined in src/libs/tasks/TaskRef.ts:50
Parameters
- name: string | object | Function
- fn: object | Function = null
- options: ITaskRefOptions = null
Returns TaskRef

Properties

$fn

$fn: object | Function = ...

$source

$source: any

Readonly metaType

metaType: METADATA_TYPE

Readonly name

name: string

namespace

namespace: string

Readonly object

object: IClassRef

Accessors

_type

get _type(): TaskRefType
set _type(type: TaskRefType): void

- Defined in src/libs/tasks/TaskRef.ts:71
Returns TaskRefType
- Defined in src/libs/tasks/TaskRef.ts:75
Parameters
- type: TaskRefType
Returns void

description

get description(): string
set description(value: string): void

- Defined in src/libs/tasks/TaskRef.ts:90
Returns string
- Defined in src/libs/tasks/TaskRef.ts:94
Parameters
- value: string
Returns void

machineName

get machineName(): string

- Defined in node_modules/@allgemein/schema-api/lib/AbstractRef.d.ts:23
Returns string

nodeInfos

get nodeInfos(): ITaskRefNodeInfo[]
set nodeInfos(nodes: ITaskRefNodeInfo[]): void

- Defined in src/libs/tasks/TaskRef.ts:98
Returns ITaskRefNodeInfo[]
- Defined in src/libs/tasks/TaskRef.ts:105
Parameters
- nodes: ITaskRefNodeInfo[]
Returns void

permissions

get permissions(): string[]
set permissions(value: string[]): void

- Defined in src/libs/tasks/TaskRef.ts:79
Returns string[]
- Defined in src/libs/tasks/TaskRef.ts:86
Parameters
- value: string[]
Returns void

storingName

get storingName(): any

- Defined in node_modules/@allgemein/schema-api/lib/AbstractRef.d.ts:24
Returns any

Methods

addNodeId

addNodeId(nodeId: string, hasWorker?: boolean): void

- Defined in src/libs/tasks/TaskRef.ts:315
Parameters
- nodeId: string
- hasWorker: boolean = false
Returns void

build

build<T>(instance: any, options?: IBuildOptions): T

Implementation of IEntityRef.build
- Defined in src/libs/tasks/TaskRef.ts:467
Type parameters
- T
Parameters
- instance: any
- Optional options: IBuildOptions
Returns T

canHaveProperties

canHaveProperties(): boolean

- Defined in src/libs/tasks/TaskRef.ts:360
Returns boolean

clone

clone(name: string): any

- Defined in src/libs/tasks/TaskRef.ts:270
Parameters
- name: string
Returns any

create

create<T>(): T

Implementation of IEntityRef.create
- Defined in src/libs/tasks/TaskRef.ts:472
Type parameters
- T
Returns T

dependencies

dependencies(): string[]

- Defined in src/libs/tasks/TaskRef.ts:444
Returns string[]

dependsOn

dependsOn(dest: string): TaskRef

- Defined in src/libs/tasks/TaskRef.ts:450
Parameters
- dest: string
Returns TaskRef

executable

executable(incoming?: {}): [object | Function, any]

- Defined in src/libs/tasks/TaskRef.ts:403
Parameters
- incoming: {} = {}
  - [k: string]: any
Returns [object | Function, any]

getClass

getClass(create?: boolean): Function

Implementation of IEntityRef.getClass

Inherited from AbstractRef.getClass
- Defined in node_modules/@allgemein/schema-api/lib/AbstractRef.d.ts:22
Parameters
- Optional create: boolean
Returns Function

getClassRef

getClassRef(): IClassRef

Implementation of IEntityRef.getClassRef

Inherited from AbstractRef.getClassRef
- Defined in node_modules/@allgemein/schema-api/lib/AbstractRef.d.ts:21
Returns IClassRef

getClassRefFor

getClassRefFor(object: string | Function | IClassRef, type: METADATA_TYPE): IClassRef

Overrides AbstractRef.getClassRefFor
- Defined in src/libs/tasks/TaskRef.ts:511
Return a class ref for passing string, Function or class ref

Parameters
- object: string | Function | IClassRef
- type: METADATA_TYPE
Returns IClassRef

getFn

getFn(): any

- Defined in src/libs/tasks/TaskRef.ts:261
Returns any

getIncomings

getIncomings(): TaskExchangeRef[]

- Defined in src/libs/tasks/TaskRef.ts:491
Returns TaskExchangeRef[]

getNamespace

getNamespace(): string

Implementation of IEntityRef.getNamespace

Inherited from AbstractRef.getNamespace
- Defined in node_modules/@allgemein/schema-api/lib/AbstractRef.d.ts:13
Returns string

getOptions

getOptions(key?: string, defaultValue?: any): any

Implementation of IEntityRef.getOptions

Inherited from AbstractRef.getOptions
- Defined in node_modules/@allgemein/schema-api/lib/AbstractRef.d.ts:17
Parameters
- Optional key: string
- Optional defaultValue: any
Returns any

Protected getOptionsEntry

getOptionsEntry(): any

Inherited from AbstractRef.getOptionsEntry
- Defined in node_modules/@allgemein/schema-api/lib/AbstractRef.d.ts:16
Returns any

getOutgoings

getOutgoings(): TaskExchangeRef[]

- Defined in src/libs/tasks/TaskRef.ts:496
Returns TaskExchangeRef[]

getPropertyRef

getPropertyRef(name: string): TaskExchangeRef

Implementation of IEntityRef.getPropertyRef
- Defined in src/libs/tasks/TaskRef.ts:481
Parameters
- name: string
Returns TaskExchangeRef

getPropertyRefs

getPropertyRefs(): TaskExchangeRef[]

Implementation of IEntityRef.getPropertyRefs
- Defined in src/libs/tasks/TaskRef.ts:486
Returns TaskExchangeRef[]

getRegistry

getRegistry(): ILookupRegistry

Implementation of IEntityRef.getRegistry

Overrides AbstractRef.getRegistry
- Defined in src/libs/tasks/TaskRef.ts:523
TODO implement

Returns ILookupRegistry

getRuntime

getRuntime(): TaskExchangeRef

- Defined in src/libs/tasks/TaskRef.ts:501
Returns TaskExchangeRef

getSchemaRefs

getSchemaRefs(): ISchemaRef[]

Implementation of IEntityRef.getSchemaRefs
- Defined in src/libs/tasks/TaskRef.ts:532
Not ne

Returns ISchemaRef[]

getSourceRef

getSourceRef(): IClassRef

Inherited from AbstractRef.getSourceRef
- Defined in node_modules/@allgemein/schema-api/lib/AbstractRef.d.ts:15
Returns IClassRef

getType

getType(): TaskRefType

- Defined in src/libs/tasks/TaskRef.ts:355
Returns TaskRefType

group

group(name: string): TaskRef

- Defined in src/libs/tasks/TaskRef.ts:456
Parameters
- name: string
Returns TaskRef

grouping

grouping(): any[]

- Defined in src/libs/tasks/TaskRef.ts:439
Returns any[]

groups

groups(): any[]

- Defined in src/libs/tasks/TaskRef.ts:434
Returns any[]

hasNodeIds

hasNodeIds(): boolean

- Defined in src/libs/tasks/TaskRef.ts:328
Returns boolean

hasOption

hasOption(key: string): boolean

Inherited from AbstractRef.hasOption
- Defined in node_modules/@allgemein/schema-api/lib/AbstractRef.d.ts:20
Parameters
- key: string
Returns boolean

hasTargetNodeId

hasTargetNodeId(nodeId: string, withWorker?: boolean): boolean

- Defined in src/libs/tasks/TaskRef.ts:307
Parameters
- nodeId: string
- withWorker: boolean = false
Returns boolean

hasWorker

hasWorker(): boolean

- Defined in src/libs/tasks/TaskRef.ts:324
Returns boolean

id

id(): string

Implementation of IEntityRef.id

Overrides AbstractRef.id
- Defined in src/libs/tasks/TaskRef.ts:462
Returns string

info

info(): ITaskInfo

- Defined in src/libs/tasks/TaskRef.ts:365
Returns ITaskInfo

isOf

isOf(instance: any): boolean

Implementation of IEntityRef.isOf
- Defined in src/libs/tasks/TaskRef.ts:476
Parameters
- instance: any
Returns boolean

isRemote

isRemote(): boolean

- Defined in src/libs/tasks/TaskRef.ts:332
Returns boolean

prepare

prepare(name: string | object | Function, fn?: object | Function): void

- Defined in src/libs/tasks/TaskRef.ts:199
Parameters
- name: string | object | Function
- fn: object | Function = null
Returns void

Private process

process(obj: any): void

- Defined in src/libs/tasks/TaskRef.ts:336
Parameters
- obj: any
Returns void

Private processGroup

processGroup(obj: any): void

- Defined in src/libs/tasks/TaskRef.ts:346
Parameters
- obj: any
Returns void

removeNodeId

removeNodeId(nodeId: string): void

- Defined in src/libs/tasks/TaskRef.ts:320
Parameters
- nodeId: string
Returns void

setOption

setOption(key: string, value: any): void

Implementation of IEntityRef.setOption

Inherited from AbstractRef.setOption
- Defined in node_modules/@allgemein/schema-api/lib/AbstractRef.d.ts:19
Parameters
- key: string
- value: any
Returns void

setOptions

setOptions(options: any): void

Implementation of IEntityRef.setOptions

Inherited from AbstractRef.setOptions
- Defined in node_modules/@allgemein/schema-api/lib/AbstractRef.d.ts:18
Parameters
- options: any
Returns void

subtasks

subtasks(): any[]

- Defined in src/libs/tasks/TaskRef.ts:428
Returns any[]

toJsonSchema

toJsonSchema(withProperties?: boolean): IJsonSchema7

- Defined in src/libs/tasks/TaskRef.ts:393
Parameters
- withProperties: boolean = true
Returns IJsonSchema7

Static dependsOn

dependsOn(src: string, dest: string, namespace?: string): void

- Defined in src/libs/tasks/TaskRef.ts:163
Parameters
- src: string
- dest: string
- namespace: string = ...
Returns void

Static getTaskName

getTaskName(x: string | object | Function): any

- Defined in src/libs/tasks/TaskRef.ts:129
Parameters
- x: string | object | Function
Returns any

Static getTaskObject

getTaskObject(name: string | object | Function, fn: object | Function): Function

- Defined in src/libs/tasks/TaskRef.ts:150
Parameters
- name: string | object | Function
- fn: object | Function
Returns Function

Static group

group(src: string, dest: string, namespace?: string): typeof TaskRef

- Defined in src/libs/tasks/TaskRef.ts:181
Parameters
- src: string
- dest: string
- namespace: string = ...
Returns typeof TaskRef

Generated using TypeDoc