Workers

Hierarchy

AbstractRegistry
- Workers

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Workers(namespace: string): Workers

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

Properties

config

config: IWorkerConfig = ...

Protected Readonly namespace

namespace: string

workers: IWorker[] = []

Static NAME

NAME: string = 'Workers'

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.

Methods

access

access(name: string): boolean

- Defined in src/libs/worker/Workers.ts:113
Parameters
- name: string
Returns boolean

activeWorkerCount

activeWorkerCount(): number

- Defined in src/libs/worker/Workers.ts:100
Returns number

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): Workers

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 Workers

addWorkerClass

addWorkerClass(fn: Function): WorkerRef

- Defined in src/libs/worker/Workers.ts:149
Parameters
- fn: Function
Returns WorkerRef

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/worker/Workers.ts:50
Parameters
- name: string
Returns boolean

create

create<T>(context: string, options: any): T

Overrides AbstractRegistry.create
- Defined in src/libs/worker/Workers.ts:165
Type parameters
- T
Parameters
- context: string
- options: any
Returns T

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

get

get(name: string): unknown

- Defined in src/libs/worker/Workers.ts:54
Parameters
- name: string
Returns unknown

getClassRefFor

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

Inherited from AbstractRegistry.getClassRefFor
- Defined in node_modules/@allgemein/schema-api/lib/registry/AbstractRegistry.d.ts:52
Method for returning class ref

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

getEntities

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

- Defined in src/libs/worker/Workers.ts:174
Parameters
- Optional filter: (x: IEntityRef) => boolean
  - - (x: IEntityRef): boolean
    - Parameters
      - x: IEntityRef
      Returns boolean
Returns IEntityRef[]

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)[]

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

getPropertyRef

getPropertyRef<T>(ref: IEntityRef | IClassRef, name: string): IPropertyRef | T

Inherited from AbstractRegistry.getPropertyRef
- Defined in node_modules/@allgemein/schema-api/lib/registry/AbstractRegistry.d.ts:58
Returns property by name for a given class or entity ref

Type parameters
- T: IPropertyRef
Parameters
- ref: IEntityRef | IClassRef
- name: string
Returns IPropertyRef | T

getPropertyRefs

getPropertyRefs<T>(ref: IEntityRef | IClassRef): (IPropertyRef | T)[]

Inherited from AbstractRegistry.getPropertyRefs
- Defined in node_modules/@allgemein/schema-api/lib/registry/AbstractRegistry.d.ts:64
Returns all properties for given class or entity ref

Type parameters
- T: IPropertyRef
Parameters
- ref: IEntityRef | IClassRef
Returns (IPropertyRef | T)[]

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[]

infos

infos(): IWorkerInfo[]

- Defined in src/libs/worker/Workers.ts:89
Returns IWorkerInfo[]

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[]

metadata

metadata(): boolean[]

- Defined in src/libs/worker/Workers.ts:80
Returns boolean[]

off

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

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 Workers

on

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

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 Workers

onStartup

onStartup(loader?: RuntimeLoader): void

- Defined in src/libs/worker/Workers.ts:34
Execute on bootstrap startup. Get all worker classes from runtime enviroment an register them.

Parameters
- Optional loader: RuntimeLoader
Returns void

once

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

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 Workers

prependListener

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

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 Workers

prependOnceListener

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

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 Workers

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[]

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): Workers

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

removeListener

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

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 Workers

reset

reset(): void

Inherited from AbstractRegistry.reset
- Defined in node_modules/@allgemein/schema-api/lib/registry/AbstractRegistry.d.ts:89
reset current registry

Returns void

setConfig

setConfig(config?: IWorkerConfig): void

- Defined in src/libs/worker/Workers.ts:42
Parameters
- config: IWorkerConfig = ...
Returns void

setMaxListeners

setMaxListeners(n: number): Workers

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

shutdown

shutdown(): Promise<void>

- Defined in src/libs/worker/Workers.ts:105
Returns Promise<void>

startup

startup(): Promise<void>

- Defined in src/libs/worker/Workers.ts:60
Returns Promise<void>

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 Workers

Properties

config

Protected Readonly namespace

workers

Static NAME

Static Readonly captureRejectionSymbol

Static captureRejections

Static defaultMaxListeners

Static Readonly errorMonitor

Methods

access

Parameters

name: string

Returns boolean

activeWorkerCount

Returns number

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 Workers

addWorkerClass

Parameters

fn: Function

Returns WorkerRef

clear

Returns void

contains

Parameters

name: string

Returns boolean

create

Type parameters

T

Parameters

context: string

options: any

Returns T

emit

Parameters

event: string | symbol

Rest ...args: any[]

Returns boolean

eventNames

Returns (string | symbol)[]

filter

Type parameters

T

Parameters

context: string

search: any

Returns T[]

find

Type parameters

T

Parameters

context: string

search: any

Returns T

get