Tasks | @typexs/base

Hierarchy

AbstractRegistry
- Tasks

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Tasks(namespace: string): Tasks

Inherited from AbstractRegistry.constructor
- Defined in node_modules/@allgemein/schema-api/lib/registry/AbstractRegistry.d.ts:14
Parameters
- namespace: string
Returns Tasks

Properties

config

config: ITasksConfig = ...

Protected Readonly namespace

namespace: string

nodeId

nodeId: string

Static NAME

NAME: string = ...

Static Readonly captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

Static captureRejections

captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

Static defaultMaxListeners

defaultMaxListeners: number

Static Readonly errorMonitor

errorMonitor: typeof errorMonitor

This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

Installing a listener using this symbol does not change the behavior once an 'error' event is emitted, therefore the process will still crash if no regular 'error' listener is installed.

Static taskId

taskId: number = 0

Methods

access

access(name: string): boolean

- Defined in src/libs/tasks/Tasks.ts:101
Parameters
- name: string
Returns boolean

add

add<T>(context: string, entry: T): T

Inherited from AbstractRegistry.add
- Defined in node_modules/@allgemein/schema-api/lib/registry/AbstractRegistry.d.ts:73
TODO

Type parameters
- T
Parameters
- context: string
- entry: T
Returns T

addListener

addListener(event: string | symbol, listener: (...args: any[]) => void): Tasks

Inherited from AbstractRegistry.addListener
- Defined in node_modules/@types/node/events.d.ts:72
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns Tasks

addRemoteTask

addRemoteTask(nodeId: string, info: ITaskInfo, hasWorker?: boolean, withProperties?: boolean): TaskRef

- Defined in src/libs/tasks/Tasks.ts:201
Parameters
- nodeId: string
- info: ITaskInfo
- hasWorker: boolean = false
- withProperties: boolean = true
Returns TaskRef

addTask

addTask(name: string | object | Function, fn?: object | Function, options?: ITaskRefOptions, withProperties?: boolean): TaskRef

- Defined in src/libs/tasks/Tasks.ts:173
Parameters
- name: string | object | Function
- fn: object | Function = null
- options: ITaskRefOptions = null
- withProperties: boolean = true
Returns TaskRef

addTaskRef

addTaskRef(task: TaskRef, nodeId: string, hasWorker?: boolean, withProperties?: boolean): TaskRef

- Defined in src/libs/tasks/Tasks.ts:219
Parameters
- task: TaskRef
- nodeId: string
- hasWorker: boolean = false
- withProperties: boolean = true
Returns TaskRef

clear

clear(): void

Inherited from AbstractRegistry.clear
- Defined in node_modules/@allgemein/schema-api/lib/registry/AbstractRegistry.d.ts:90
Returns void

contains

contains(name: string): boolean

- Defined in src/libs/tasks/Tasks.ts:272
Parameters
- name: string
Returns boolean

Private containsGroup

containsGroup(name: string): boolean

- Defined in src/libs/tasks/Tasks.ts:281
Parameters
- name: string
Returns boolean

Private containsTask

containsTask(name: string): boolean

- Defined in src/libs/tasks/Tasks.ts:277
Parameters
- name: string
Returns boolean

create

create<T>(context: string, options: ITaskPropertyRefOptions | (ITaskRefOptions & ITaskInfo & { nodeId?: string; taskName?: string; title?: string })): T

Overrides AbstractRegistry.create
- Defined in src/libs/tasks/Tasks.ts:152
Type parameters
- T
Parameters
- context: string
- options: ITaskPropertyRefOptions | (ITaskRefOptions & ITaskInfo & { nodeId?: string; taskName?: string; title?: string })
Returns T

createTaskRef

createTaskRef(options: ITaskRefOptions & ITaskInfo & { nodeId?: string; taskName?: string; title?: string }): any

- Defined in src/libs/tasks/Tasks.ts:137
Parameters
- options: ITaskRefOptions & ITaskInfo & { nodeId?: string; taskName?: string; title?: string }
Returns any

dependsOn

dependsOn(src: string, dest: string): Tasks

- Defined in src/libs/tasks/Tasks.ts:307
Fires src after execution of dest

src dependsOn dest

Parameters
- src: string
- dest: string
Returns Tasks

emit

emit(event: string | symbol, ...args: any[]): boolean

Inherited from AbstractRegistry.emit
- Defined in node_modules/@types/node/events.d.ts:82
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean

eventNames

eventNames(): (string | symbol)[]

Inherited from AbstractRegistry.eventNames
- Defined in node_modules/@types/node/events.d.ts:87
Returns (string | symbol)[]

filter

filter<T>(context: string, search: any): T[]

Inherited from AbstractRegistry.filter
- Defined in node_modules/@allgemein/schema-api/lib/registry/AbstractRegistry.d.ts:77
TODO

Type parameters
- T
Parameters
- context: string
- search: any
Returns T[]

find

find<T>(context: string, search: any): T

Inherited from AbstractRegistry.find
- Defined in node_modules/@allgemein/schema-api/lib/registry/AbstractRegistry.d.ts:81
TODO

Type parameters
- T
Parameters
- context: string
- search: any
Returns T

fromJsonSchema

fromJsonSchema(orgJson: any): Promise<TaskRef | TaskRef[]>

- Defined in src/libs/tasks/Tasks.ts:370
Parameters
- orgJson: any
Returns Promise<TaskRef | TaskRef[]>

get

get(name: string): TaskRef

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

getClassRefFor

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

Overrides AbstractRegistry.getClassRefFor
- Defined in src/libs/tasks/Tasks.ts:442
Return a class ref for passing string, Function or class ref

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

getEntityRefFor

getEntityRefFor<T>(fn: string | object | Function, skipNsCheck?: boolean): IEntityRef | T

Inherited from AbstractRegistry.getEntityRefFor
- Defined in node_modules/@allgemein/schema-api/lib/registry/AbstractRegistry.d.ts:41
Can get get entity ref for function.

Type parameters
- T: IEntityRef
Parameters
- fn: string | object | Function
- Optional skipNsCheck: boolean
Returns IEntityRef | T

getEntityRefs

getEntityRefs<T>(filter?: (x: IEntityRef) => boolean): (IEntityRef | T)[]

Inherited from AbstractRegistry.getEntityRefs
- Defined in node_modules/@allgemein/schema-api/lib/registry/AbstractRegistry.d.ts:35
TODO

Type parameters
- T: IEntityRef
Parameters
- Optional filter: (x: IEntityRef) => boolean
  - - (x: IEntityRef): boolean
    - Parameters
      - x: IEntityRef
      Returns boolean
Returns (IEntityRef | T)[]

Private getEntries

getEntries(withRemote?: boolean): TaskRef[]

- Defined in src/libs/tasks/Tasks.ts:55
Parameters
- withRemote: boolean = false
Returns TaskRef[]

getLookupRegistry

getLookupRegistry(): LookupRegistry

Inherited from AbstractRegistry.getLookupRegistry
- Defined in node_modules/@allgemein/schema-api/lib/registry/AbstractRegistry.d.ts:45
Returns the used instance of lookup registry handler

Returns LookupRegistry

getMaxListeners

getMaxListeners(): number

Inherited from AbstractRegistry.getMaxListeners
- Defined in node_modules/@types/node/events.d.ts:79
Returns number

getNames

getNames(withRemote?: boolean): string[]

- Defined in src/libs/tasks/Tasks.ts:75
Parameters
- withRemote: boolean = false
Returns string[]

getNodeId

getNodeId(): string

- Defined in src/libs/tasks/Tasks.ts:46
Returns string

getPropertyRef

getPropertyRef(ref: IEntityRef | IClassRef, name: string): TaskExchangeRef

Overrides AbstractRegistry.getPropertyRef
- Defined in src/libs/tasks/Tasks.ts:422
Parameters
- ref: IEntityRef | IClassRef
- name: string
Returns TaskExchangeRef

getPropertyRefs

getPropertyRefs(ref: IEntityRef | IClassRef): TaskExchangeRef[]

Overrides AbstractRegistry.getPropertyRefs
- Defined in src/libs/tasks/Tasks.ts:429
Parameters
- ref: IEntityRef | IClassRef
Returns TaskExchangeRef[]

getPropertyRefsFor

getPropertyRefsFor<T>(fn: string | object | Function): (IPropertyRef | T)[]

Inherited from AbstractRegistry.getPropertyRefsFor
- Defined in node_modules/@allgemein/schema-api/lib/registry/AbstractRegistry.d.ts:65
Type parameters
- T: IPropertyRef
Parameters
- fn: string | object | Function
Returns (IPropertyRef | T)[]

getSchemaRefs

getSchemaRefs<T>(filter?: (x: ISchemaRef) => boolean): (ISchemaRef | T)[]

Inherited from AbstractRegistry.getSchemaRefs
- Defined in node_modules/@allgemein/schema-api/lib/registry/AbstractRegistry.d.ts:22
Return all registered schema references

Type parameters
- T: ISchemaRef
Parameters
- Optional filter: (x: ISchemaRef) => boolean
  - - (x: ISchemaRef): boolean
    - Parameters
      - x: ISchemaRef
      Returns boolean
Returns (ISchemaRef | T)[]

ISchemaRef[]

getSchemaRefsFor

getSchemaRefsFor<T>(ref: string): ISchemaRef | T

Inherited from AbstractRegistry.getSchemaRefsFor
- Defined in node_modules/@allgemein/schema-api/lib/registry/AbstractRegistry.d.ts:29
Return schema references for an given entity or class reference

Type parameters
- T: ISchemaRef
Parameters
- ref: string
Returns ISchemaRef | T

ISchemaRef[]

getTasks

getTasks(names: string | string[]): TaskRef[]

- Defined in src/libs/tasks/Tasks.ts:60
Parameters
- names: string | string[]
Returns TaskRef[]

group

group(src: string, dest: string): Tasks

- Defined in src/libs/tasks/Tasks.ts:293
Fires src as subtask of dest

src attachTo dest

Parameters
- src: string
- dest: string
Returns Tasks

infos

infos(withRemote?: boolean): ITaskInfo[]

- Defined in src/libs/tasks/Tasks.ts:85
Parameters
- withRemote: boolean = false
Returns ITaskInfo[]

list

list<X>(type: METADATA_TYPE, filter?: (x: any) => boolean): X[]

Inherited from AbstractRegistry.list
- Defined in node_modules/@allgemein/schema-api/lib/registry/AbstractRegistry.d.ts:66
Type parameters
- X
Parameters
- type: METADATA_TYPE
- Optional filter: (x: any) => boolean
  - - (x: any): boolean
    - Parameters
      - x: any
      Returns boolean
Returns X[]

listEntities

listEntities(filter?: (x: IEntityRef) => boolean): IEntityRef[]

Inherited from AbstractRegistry.listEntities
- Defined in node_modules/@allgemein/schema-api/lib/registry/AbstractRegistry.d.ts:67
Parameters
- Optional filter: (x: IEntityRef) => boolean
  - - (x: IEntityRef): boolean
    - Parameters
      - x: IEntityRef
      Returns boolean
Returns IEntityRef[]

listProperties

listProperties(filter?: (x: IPropertyRef) => boolean): IPropertyRef[]

Inherited from AbstractRegistry.listProperties
- Defined in node_modules/@allgemein/schema-api/lib/registry/AbstractRegistry.d.ts:68
Parameters
- Optional filter: (x: IPropertyRef) => boolean
  - - (x: IPropertyRef): boolean
    - Parameters
      - x: IPropertyRef
      Returns boolean
Returns IPropertyRef[]

listenerCount

listenerCount(event: string | symbol): number

Inherited from AbstractRegistry.listenerCount
- Defined in node_modules/@types/node/events.d.ts:83
Parameters
- event: string | symbol
Returns number

listeners

listeners(event: string | symbol): Function[]

Inherited from AbstractRegistry.listeners
- Defined in node_modules/@types/node/events.d.ts:80
Parameters
- event: string | symbol
Returns Function[]

names

names(withRemote?: boolean): string[]

- Defined in src/libs/tasks/Tasks.ts:80
Parameters
- withRemote: boolean = false
Returns string[]

new

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

- Defined in src/libs/tasks/Tasks.ts:267
deprecated

Parameters
- name: string | Function
- fn: Function = null
- options: any = null
Returns TaskRef

off

off(event: string | symbol, listener: (...args: any[]) => void): Tasks

Inherited from AbstractRegistry.off
- Defined in node_modules/@types/node/events.d.ts:76
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns Tasks

on

on(event: string | symbol, listener: (...args: any[]) => void): Tasks

Inherited from AbstractRegistry.on
- Defined in node_modules/@types/node/events.d.ts:73
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns Tasks

once

once(event: string | symbol, listener: (...args: any[]) => void): Tasks

Inherited from AbstractRegistry.once
- Defined in node_modules/@types/node/events.d.ts:74
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns Tasks

prependListener

prependListener(event: string | symbol, listener: (...args: any[]) => void): Tasks

Inherited from AbstractRegistry.prependListener
- Defined in node_modules/@types/node/events.d.ts:85
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns Tasks

prependOnceListener

prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): Tasks

Inherited from AbstractRegistry.prependOnceListener
- Defined in node_modules/@types/node/events.d.ts:86
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns Tasks

rawListeners

rawListeners(event: string | symbol): Function[]

Inherited from AbstractRegistry.rawListeners
- Defined in node_modules/@types/node/events.d.ts:81
Parameters
- event: string | symbol
Returns Function[]

register

- Defined in src/libs/tasks/Tasks.ts:401
Parameters
- xsdef: AbstractRef | Binding
Returns AbstractRef | Binding

remove

remove<T>(context: string, search: any): T[]

Inherited from AbstractRegistry.remove
- Defined in node_modules/@allgemein/schema-api/lib/registry/AbstractRegistry.d.ts:85
TODO

Type parameters
- T
Parameters
- context: string
- search: any
Returns T[]

removeAllListeners

removeAllListeners(event?: string | symbol): Tasks

Inherited from AbstractRegistry.removeAllListeners
- Defined in node_modules/@types/node/events.d.ts:77
Parameters
- Optional event: string | symbol
Returns Tasks

removeListener

removeListener(event: string | symbol, listener: (...args: any[]) => void): Tasks

Inherited from AbstractRegistry.removeListener
- Defined in node_modules/@types/node/events.d.ts:75
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns Tasks

removeTask

removeTask(task: TaskRef): void

- Defined in src/libs/tasks/Tasks.ts:252
Parameters
- task: TaskRef
Returns void

reset

reset(): void

Overrides AbstractRegistry.reset
- Defined in src/libs/tasks/Tasks.ts:365
Returns void

setConfig

setConfig(config?: ITasksConfig): void

- Defined in src/libs/tasks/Tasks.ts:41
Parameters
- config: ITasksConfig = ...
Returns void

setMaxListeners

setMaxListeners(n: number): Tasks

Inherited from AbstractRegistry.setMaxListeners
- Defined in node_modules/@types/node/events.d.ts:78
Parameters
- n: number
Returns Tasks

setNodeId

setNodeId(nodeId: string): void

- Defined in src/libs/tasks/Tasks.ts:50
Parameters
- nodeId: string
Returns void

task

task(name: string, fn: Function, options: any): TaskRef

- Defined in src/libs/tasks/Tasks.ts:340
Parameters
- name: string
- fn: Function
- options: any
Returns TaskRef

taskGroup

taskGroup(name: string): TaskRef

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

taskMap

taskMap(new_name: string, name: string): TaskRef

- Defined in src/libs/tasks/Tasks.ts:328
Parameters
- new_name: string
- name: string
Returns TaskRef

toJsonSchema

toJsonSchema(): IJsonSchema7

- Defined in src/libs/tasks/Tasks.ts:354
Returns IJsonSchema7

Static getEventListener

getEventListener(emitter: EventEmitter | DOMEventTarget, name: string | symbol): Function[]

Inherited from AbstractRegistry.getEventListener
- Defined in node_modules/@types/node/events.d.ts:34
Returns a list listener for a specific emitter event name.

Parameters
- emitter: EventEmitter | DOMEventTarget
- name: string | symbol
Returns Function[]

Static listenerCount

listenerCount(emitter: EventEmitter, event: string | symbol): number

Inherited from AbstractRegistry.listenerCount
- Defined in node_modules/@types/node/events.d.ts:30
deprecated

since v4.0.0

Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number

Static on

on(emitter: EventEmitter, event: string, options?: StaticEventEmitterOptions): AsyncIterableIterator<any>

Inherited from AbstractRegistry.on
- Defined in node_modules/@types/node/events.d.ts:27
Parameters
- emitter: EventEmitter
- event: string
- Optional options: StaticEventEmitterOptions
Returns AsyncIterableIterator<any>

Static once

once(emitter: NodeEventTarget, event: string | symbol, options?: StaticEventEmitterOptions): Promise<any[]>
once(emitter: DOMEventTarget, event: string, options?: StaticEventEmitterOptions): Promise<any[]>

Inherited from AbstractRegistry.once
- Defined in node_modules/@types/node/events.d.ts:25
Parameters
- emitter: NodeEventTarget
- event: string | symbol
- Optional options: StaticEventEmitterOptions
Returns Promise<any[]>
Inherited from AbstractRegistry.once
- Defined in node_modules/@types/node/events.d.ts:26
Parameters
- emitter: DOMEventTarget
- event: string
- Optional options: StaticEventEmitterOptions
Returns Promise<any[]>

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

namespace: string

Returns Tasks

Properties

config

Protected Readonly namespace

nodeId

Static NAME

Static Readonly captureRejectionSymbol

Static captureRejections

Static defaultMaxListeners

Static Readonly errorMonitor

Static taskId

Methods

access

Parameters

name: string

Returns boolean

add

Type parameters

T

Parameters

context: string

entry: T

Returns T

addListener

Parameters

event: string | symbol

listener: (...args: any[]) => void

Parameters

Rest ...args: any[]

Returns void

Returns Tasks

addRemoteTask

Parameters

nodeId: string

info: ITaskInfo

hasWorker: boolean = false

withProperties: boolean = true

Returns TaskRef

addTask

Parameters

name: string | object | Function

fn: object | Function = null

options: ITaskRefOptions = null

withProperties: boolean = true

Returns TaskRef

addTaskRef

Parameters

task: TaskRef

nodeId: string

hasWorker: boolean = false

withProperties: boolean = true

Returns TaskRef

clear

Returns void

contains

Parameters

name: string

Returns boolean

Private containsGroup

Parameters

name: string

Returns boolean

Private containsTask

Parameters

name: string

Returns boolean

create

Type parameters

T

Parameters

context: string