Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Tasks

Hierarchy

  • AbstractRegistry
    • Tasks

Index

Constructors

constructor

  • new Tasks(namespace: string): Tasks
  • 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

add

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

    Type parameters

    • T

    Parameters

    • context: string
    • entry: T

    Returns T

addListener

  • addListener(event: string | symbol, listener: (...args: any[]) => void): Tasks
  • 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

addTask

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

addTaskRef

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

clear

  • clear(): void
  • Returns void

contains

  • contains(name: string): boolean

Private containsGroup

  • containsGroup(name: string): boolean

Private containsTask

  • containsTask(name: string): boolean

create

createTaskRef

dependsOn

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

emit

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

    • event: string | symbol
    • Rest ...args: any[]

    Returns boolean

eventNames

  • eventNames(): (string | symbol)[]
  • Returns (string | symbol)[]

filter

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

    Type parameters

    • T

    Parameters

    • context: string
    • search: any

    Returns T[]

find

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

    Type parameters

    • T

    Parameters

    • context: string
    • search: any

    Returns T

fromJsonSchema

get

getClassRefFor

  • getClassRefFor(object: string | Function | IClassRef, type: METADATA_TYPE): IClassRef
  • 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
  • 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)[]
  • 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[]

getLookupRegistry

  • getLookupRegistry(): LookupRegistry
  • Returns the used instance of lookup registry handler

    Returns LookupRegistry

getMaxListeners

  • getMaxListeners(): number
  • Returns number

getNames

  • getNames(withRemote?: boolean): string[]

getNodeId

  • getNodeId(): string

getPropertyRef

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

getPropertyRefs

getPropertyRefsFor

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

    • T: IPropertyRef

    Parameters

    • fn: string | object | Function

    Returns (IPropertyRef | T)[]

getSchemaRefs

  • getSchemaRefs<T>(filter?: (x: ISchemaRef) => boolean): (ISchemaRef | T)[]
  • 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
  • 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[]

group

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

infos

list

  • list<X>(type: METADATA_TYPE, filter?: (x: any) => boolean): X[]
  • 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[]
  • Parameters

    • Optional filter: (x: IEntityRef) => boolean
        • (x: IEntityRef): boolean
        • Parameters

          • x: IEntityRef

          Returns boolean

    Returns IEntityRef[]

listProperties

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

    • Optional filter: (x: IPropertyRef) => boolean
        • (x: IPropertyRef): boolean
        • Parameters

          • x: IPropertyRef

          Returns boolean

    Returns IPropertyRef[]

listenerCount

  • listenerCount(event: string | symbol): number
  • Parameters

    • event: string | symbol

    Returns number

listeners

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

    • event: string | symbol

    Returns Function[]

names

  • names(withRemote?: boolean): string[]

new

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

off

  • off(event: string | symbol, listener: (...args: any[]) => void): Tasks
  • 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
  • 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
  • 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
  • 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
  • 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[]
  • Parameters

    • event: string | symbol

    Returns Function[]

register

  • register(xsdef: AbstractRef | Binding): AbstractRef | Binding

remove

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

    Type parameters

    • T

    Parameters

    • context: string
    • search: any

    Returns T[]

removeAllListeners

  • removeAllListeners(event?: string | symbol): Tasks
  • Parameters

    • Optional event: string | symbol

    Returns Tasks

removeListener

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

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns Tasks

removeTask

reset

  • reset(): void

setConfig

setMaxListeners

  • setMaxListeners(n: number): Tasks
  • Parameters

    • n: number

    Returns Tasks

setNodeId

  • setNodeId(nodeId: string): void

task

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

taskGroup

taskMap

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

toJsonSchema

  • toJsonSchema(): IJsonSchema7

Static getEventListener

  • getEventListener(emitter: EventEmitter | DOMEventTarget, name: string | symbol): Function[]
  • 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
  • deprecated

    since v4.0.0

    Parameters

    • emitter: EventEmitter
    • event: string | symbol

    Returns number

Static on

  • on(emitter: EventEmitter, event: string, options?: StaticEventEmitterOptions): AsyncIterableIterator<any>
  • 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[]>
  • Parameters

    • emitter: NodeEventTarget
    • event: string | symbol
    • Optional options: StaticEventEmitterOptions

    Returns Promise<any[]>

  • Parameters

    • emitter: DOMEventTarget
    • event: string
    • Optional options: StaticEventEmitterOptions

    Returns Promise<any[]>

Generated using TypeDoc