Class NullTaskRef

Hierarchy

TaskRef
- NullTaskRef

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new NullTaskRef(): NullTaskRef

Overrides TaskRef.constructor
- Defined in src/libs/tasks/NullTaskRef.ts:3
Returns NullTaskRef

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

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

build

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

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

canHaveProperties

canHaveProperties(): boolean

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

clone

clone(name: string): any

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

create

create<T>(): T

Inherited from TaskRef.create
- Defined in src/libs/tasks/TaskRef.ts:472
Type parameters
- T
Returns T

dependencies

dependencies(): string[]

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

dependsOn

dependsOn(name: string): NullTaskRef

Overrides TaskRef.dependsOn
- Defined in src/libs/tasks/NullTaskRef.ts:29
Parameters
- name: string
Returns NullTaskRef

executable

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

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

getClass

getClass(create?: boolean): Function

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

getClassRef

getClassRef(): IClassRef

Inherited from TaskRef.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

Inherited from TaskRef.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

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

getIncomings

getIncomings(): TaskExchangeRef[]

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

getNamespace

getNamespace(): string

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

getOptions

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

Inherited from TaskRef.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 TaskRef.getOptionsEntry
- Defined in node_modules/@allgemein/schema-api/lib/AbstractRef.d.ts:16
Returns any

getOutgoings

getOutgoings(): TaskExchangeRef[]

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

getPropertyRef

getPropertyRef(name: string): TaskExchangeRef

Inherited from TaskRef.getPropertyRef
- Defined in src/libs/tasks/TaskRef.ts:481
Parameters
- name: string
Returns TaskExchangeRef

getPropertyRefs

getPropertyRefs(): TaskExchangeRef[]

Inherited from TaskRef.getPropertyRefs
- Defined in src/libs/tasks/TaskRef.ts:486
Returns TaskExchangeRef[]

getRegistry

getRegistry(): ILookupRegistry

Inherited from TaskRef.getRegistry
- Defined in src/libs/tasks/TaskRef.ts:523
TODO implement

Returns ILookupRegistry

getRuntime

getRuntime(): TaskExchangeRef

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

getSchemaRefs

getSchemaRefs(): ISchemaRef[]

Inherited from TaskRef.getSchemaRefs
- Defined in src/libs/tasks/TaskRef.ts:532
Not ne

Returns ISchemaRef[]

getSourceRef

getSourceRef(): IClassRef

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

getType

getType(): TaskRefType

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

group

group(name: string): NullTaskRef

Overrides TaskRef.group
- Defined in src/libs/tasks/NullTaskRef.ts:25
Parameters
- name: string
Returns NullTaskRef

grouping

grouping(): any[]

Overrides TaskRef.grouping
- Defined in src/libs/tasks/NullTaskRef.ts:17
Returns any[]

groups

groups(): any[]

Overrides TaskRef.groups
- Defined in src/libs/tasks/NullTaskRef.ts:21
Returns any[]

hasNodeIds

hasNodeIds(): boolean

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

hasOption

hasOption(key: string): boolean

Inherited from TaskRef.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

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

hasWorker

hasWorker(): boolean

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

id

id(): string

Inherited from TaskRef.id
- Defined in src/libs/tasks/TaskRef.ts:462
Returns string

info

info(): ITaskInfo

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

isOf

isOf(instance: any): boolean

Inherited from TaskRef.isOf
- Defined in src/libs/tasks/TaskRef.ts:476
Parameters
- instance: any
Returns boolean

isRemote

isRemote(): boolean

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

prepare

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

Overrides TaskRef.prepare
- Defined in src/libs/tasks/NullTaskRef.ts:9
Parameters
- name: any = null
- fn: object | Function = null
Returns void

removeNodeId

removeNodeId(nodeId: string): void

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

setOption

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

Inherited from TaskRef.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

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

subtasks

subtasks(): any[]

Overrides TaskRef.subtasks
- Defined in src/libs/tasks/NullTaskRef.ts:13
Returns any[]

toJsonSchema

toJsonSchema(withProperties?: boolean): IJsonSchema7

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

Static dependsOn

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

Inherited from TaskRef.dependsOn
- 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

Inherited from TaskRef.getTaskName
- 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

Inherited from TaskRef.getTaskObject
- 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

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

Generated using TypeDoc