DistributedAggregateOp | @typexs/base

Hierarchy

AbstractMessage<DistributedAggregateRequest, DistributedAggregateResponse>
- DistributedAggregateOp

Implements

IAggregateOp

Index

Constructors

constructor

Constructors

constructor

new DistributedAggregateOp(system: System, entityControllerRegistry: EntityControllerRegistry): DistributedAggregateOp

Overrides AbstractMessage<DistributedAggregateRequest, DistributedAggregateResponse>.constructor
- Defined in src/libs/distributed_storage/aggregate/DistributedAggregateOp.ts:26
Parameters
- system: System
- entityControllerRegistry: EntityControllerRegistry
Returns DistributedAggregateOp

Properties

Protected active

active: boolean = true

Protected detectTargets

detectTargets: boolean

Detect targets

Protected entityControllerRegistry

entityControllerRegistry: EntityControllerRegistry

Protected entityType

entityType: string | Function | ClassType<any>

Protected logger

logger: ILoggerApi

Protected options

options: IMessageOptions

Protected pipeline

pipeline: any[]

Protected results

results: any

Protected start

start: Date

Protected stop

stop: Date

Protected system

system: System

Protected targetIds

targetIds: string[]

Protected timeout

timeout: number = 5000

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

addListener

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

Inherited from AbstractMessage.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 DistributedAggregateOp

Optional beforeSend

beforeSend(req: DistributedAggregateRequest): void

Inherited from AbstractMessage.beforeSend
- Defined in src/libs/messaging/AbstractMessage.ts:101
Parameters
- req: DistributedAggregateRequest
Returns void

doPostProcess

doPostProcess(responses: DistributedAggregateResponse[], err?: Error): any

Overrides AbstractMessage.doPostProcess
- Defined in src/libs/distributed_storage/aggregate/DistributedAggregateOp.ts:91
Parameters
- responses: DistributedAggregateResponse[]
- Optional err: Error
Returns any

emit

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

Inherited from AbstractMessage.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 AbstractMessage.eventNames
- Defined in node_modules/@types/node/events.d.ts:87
Returns (string | symbol)[]

getEntityType

getEntityType(): string | Function | ClassType<any>

Implementation of IAggregateOp.getEntityType
- Defined in src/libs/distributed_storage/aggregate/DistributedAggregateOp.ts:119
Returns string | Function | ClassType<any>

getLocalNodeId

getLocalNodeId(): string

Inherited from AbstractMessage.getLocalNodeId
- Defined in src/libs/messaging/AbstractMessage.ts:88
Returns string

getMaxListeners

getMaxListeners(): number

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

getOptions

getOptions(): IDistributedAggregateOptions

Implementation of IAggregateOp.getOptions
- Defined in src/libs/distributed_storage/aggregate/DistributedAggregateOp.ts:35
Returns IDistributedAggregateOptions

getPipeline

getPipeline(): any[]

Implementation of IAggregateOp.getPipeline
- Defined in src/libs/distributed_storage/aggregate/DistributedAggregateOp.ts:123
Returns any[]

getReqClass

getReqClass(): ClassType<DistributedAggregateRequest>

Inherited from AbstractMessage.getReqClass
- Defined in src/libs/messaging/AbstractMessage.ts:92
Returns ClassType<DistributedAggregateRequest>

getResClass

getResClass(): ClassType<DistributedAggregateResponse>

Inherited from AbstractMessage.getResClass
- Defined in src/libs/messaging/AbstractMessage.ts:96
Returns ClassType<DistributedAggregateResponse>

getSystem

getSystem(): System

Inherited from AbstractMessage.getSystem
- Defined in src/libs/messaging/AbstractMessage.ts:84
Returns System

listenerCount

listenerCount(event: string | symbol): number

Inherited from AbstractMessage.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 AbstractMessage.listeners
- Defined in node_modules/@types/node/events.d.ts:80
Parameters
- event: string | symbol
Returns Function[]

off

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

Inherited from AbstractMessage.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 DistributedAggregateOp

on

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

Inherited from AbstractMessage.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 DistributedAggregateOp

onResults

onResults(res: DistributedAggregateResponse): void

Inherited from AbstractMessage.onResults
- Defined in src/libs/messaging/AbstractMessage.ts:189
Parameters
- res: DistributedAggregateResponse
Returns void

once

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

Inherited from AbstractMessage.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 DistributedAggregateOp

postProcess

postProcess(err?: Error): Promise<void>

Inherited from AbstractMessage.postProcess
- Defined in src/libs/messaging/AbstractMessage.ts:149
Parameters
- err: Error = null
Returns Promise<void>

prepare

prepare(controller: DistributedStorageEntityController): DistributedAggregateOp

- Defined in src/libs/distributed_storage/aggregate/DistributedAggregateOp.ts:39
Parameters
- controller: DistributedStorageEntityController
Returns DistributedAggregateOp

prependListener

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

Inherited from AbstractMessage.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 DistributedAggregateOp

prependOnceListener

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

Inherited from AbstractMessage.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 DistributedAggregateOp

rawListeners

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

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

ready

ready(): Promise<unknown>

Inherited from AbstractMessage.ready
- Defined in src/libs/messaging/AbstractMessage.ts:227
Returns Promise<unknown>

removeAllListeners

removeAllListeners(event?: string | symbol): DistributedAggregateOp

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

removeListener

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

Inherited from AbstractMessage.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 DistributedAggregateOp

requestCheck

requestCheck(res: DistributedAggregateResponse): boolean

Inherited from AbstractMessage.requestCheck
- Defined in src/libs/messaging/AbstractMessage.ts:184
Overrideable method to additionaly check if response is valid.

If false the response will be ignored in onResults.

Parameters
- res: DistributedAggregateResponse
Returns boolean

run

run(entryType: string | Function | ClassType<any>, pipeline: any[], options?: IDistributedAggregateOptions): Promise<any[]>

Implementation of IAggregateOp.run
- Defined in src/libs/distributed_storage/aggregate/DistributedAggregateOp.ts:43
Parameters
- entryType: string | Function | ClassType<any>
- pipeline: any[]
- Optional options: IDistributedAggregateOptions
Returns Promise<any[]>

send

send(req: DistributedAggregateRequest): Promise<any[]>

Inherited from AbstractMessage.send
- Defined in src/libs/messaging/AbstractMessage.ts:105
Parameters
- req: DistributedAggregateRequest
Returns Promise<any[]>

setMaxListeners

setMaxListeners(n: number): DistributedAggregateOp

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

target

target(nodeId: string): DistributedAggregateOp

Inherited from AbstractMessage.target
- Defined in src/libs/messaging/AbstractMessage.ts:73
Parameters
- nodeId: string
Returns DistributedAggregateOp

Static getEventListener

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

Inherited from AbstractMessage.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 AbstractMessage.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 AbstractMessage.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 AbstractMessage.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 AbstractMessage.once
- Defined in node_modules/@types/node/events.d.ts:26
Parameters
- emitter: DOMEventTarget
- event: string
- Optional options: StaticEventEmitterOptions
Returns Promise<any[]>

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

system: System

entityControllerRegistry: EntityControllerRegistry

Returns DistributedAggregateOp

Properties

Protected active

Protected detectTargets

Protected entityControllerRegistry

Protected entityType

Protected logger

Protected options

Protected pipeline

Protected Readonly reqClass

Protected request

Protected Readonly resClass

Protected responses

Protected results

Protected start

Protected stop

Protected system

Protected targetIds

Protected timeout

Static Readonly captureRejectionSymbol

Static captureRejections

Static defaultMaxListeners

Static Readonly errorMonitor

Methods

addListener

Parameters

event: string | symbol

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

Parameters

Rest ...args: any[]

Returns void

Returns DistributedAggregateOp

Optional beforeSend

Parameters

req: DistributedAggregateRequest

Returns void

doPostProcess

Parameters

responses: DistributedAggregateResponse[]

Optional err: Error

Returns any

emit

Parameters

event: string | symbol

Rest ...args: any[]

Returns boolean

eventNames

Returns (string | symbol)[]

getEntityType

Returns string | Function | ClassType<any>

getLocalNodeId

Returns string

getMaxListeners

Returns number

getOptions

Returns IDistributedAggregateOptions

getPipeline

Returns any[]

getReqClass

Returns ClassType<DistributedAggregateRequest>

getResClass

Returns ClassType<DistributedAggregateResponse>

getSystem

Returns System

listenerCount

Parameters

event: string | symbol

Returns number

listeners