Class Farm

Hierarchy

EventEmitter
- Farm

Index

Constructors

constructor

Properties

Constructors

constructor

new Farm(options: InternalFarmOptions): Farm

- Defined in Farm.ts:28
Parameters
- options: InternalFarmOptions
Returns Farm

Properties

Private debug

debug: logger.IDebugger

id

id: number

killed

killed: boolean = false

options

options: InternalFarmOptions

pendingCalls

pendingCalls: Call[] = []

queue

queue: Call[] = []

Private serializer

serializer: Serializer

Private workerCounter

workerCounter: number = 0

workers

workers: Worker[] = []

Static defaultMaxListeners

defaultMaxListeners: number

Static Private farmCount

farmCount: number = 0

Methods

addListener

addListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.addListener

Overrides EventEmitter.addListener
- Defined in /home/hugo/Desktop/workhorse/node_modules/@types/node/index.d.ts:1026
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

broadcast

broadcast(...args: any[]): Promise<any[]>

- Defined in Farm.ts:49
Parameters
- Rest ...args: any[]
Returns Promise<any[]>

broadcastMethod

broadcastMethod(method?: undefined | string, ...args: any[]): Promise<[any[], Error[]]>

- Defined in Farm.ts:53
Parameters
- Optional method: undefined | string
- Rest ...args: any[]
Returns Promise<[any[], Error[]]>

createWorkers

createWorkers(): void

- Defined in Farm.ts:85
Returns void

Private dispatch

dispatch(options: CallOptions): Promise<any>

- Defined in Farm.ts:149
Parameters
- options: CallOptions
Returns Promise<any>

emit

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

Inherited from EventEmitter.emit

Overrides EventEmitter.emit
- Defined in /home/hugo/Desktop/workhorse/node_modules/@types/node/index.d.ts:1038
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean

eventNames

eventNames(): Array<string | symbol>

Inherited from EventEmitter.eventNames

Overrides EventEmitter.eventNames
- Defined in /home/hugo/Desktop/workhorse/node_modules/@types/node/index.d.ts:1039
Returns Array<string | symbol>

Private getAvailableWorker

getAvailableWorker(): Worker | void

- Defined in Farm.ts:231
Returns Worker | void

getMaxListeners

getMaxListeners(): number

Inherited from EventEmitter.getMaxListeners

Overrides EventEmitter.getMaxListeners
- Defined in /home/hugo/Desktop/workhorse/node_modules/@types/node/index.d.ts:1035
Returns number

Private getWorkerById

getWorkerById(id: any): Worker | void

- Defined in Farm.ts:223
Parameters
- id: any
Returns Worker | void

Private init

init(): void

- Defined in Farm.ts:316
Returns void

Private isPoolAvailable

isPoolAvailable(): boolean

- Defined in Farm.ts:249
Returns boolean

kill

kill(): void

- Defined in Farm.ts:72
Returns void

Private listenToWorker

listenToWorker(worker: Worker): void

- Defined in Farm.ts:285
Parameters
- worker: Worker
Returns void

listenerCount

listenerCount(type: string | symbol): number

Inherited from EventEmitter.listenerCount

Overrides EventEmitter.listenerCount
- Defined in /home/hugo/Desktop/workhorse/node_modules/@types/node/index.d.ts:1040
Parameters
- type: string | symbol
Returns number

listeners

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

Inherited from EventEmitter.listeners

Overrides EventEmitter.listeners
- Defined in /home/hugo/Desktop/workhorse/node_modules/@types/node/index.d.ts:1036
Parameters
- event: string | symbol
Returns Function[]

off

off(event: string | symbol, listener: function): this

Inherited from EventEmitter.off

Overrides EventEmitter.off
- Defined in /home/hugo/Desktop/workhorse/node_modules/@types/node/index.d.ts:1032
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

on

on(event: string | symbol, listener: function): this

Inherited from EventEmitter.on

Overrides EventEmitter.on
- Defined in /home/hugo/Desktop/workhorse/node_modules/@types/node/index.d.ts:1027
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

once

once(event: string | symbol, listener: function): this

Inherited from EventEmitter.once

Overrides EventEmitter.once
- Defined in /home/hugo/Desktop/workhorse/node_modules/@types/node/index.d.ts:1028
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

prependListener

prependListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.prependListener

Overrides EventEmitter.prependListener
- Defined in /home/hugo/Desktop/workhorse/node_modules/@types/node/index.d.ts:1029
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

prependOnceListener

prependOnceListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in /home/hugo/Desktop/workhorse/node_modules/@types/node/index.d.ts:1030
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

Private processQueue

processQueue(): void

- Defined in Farm.ts:259
Returns void

rawListeners

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

Inherited from EventEmitter.rawListeners

Overrides EventEmitter.rawListeners
- Defined in /home/hugo/Desktop/workhorse/node_modules/@types/node/index.d.ts:1037
Parameters
- event: string | symbol
Returns Function[]

Private receive

receive(data: WorkerToMasterMessage): void

- Defined in Farm.ts:129
Parameters
- data: WorkerToMasterMessage
Returns void

removeAllListeners

removeAllListeners(event?: string | symbol): this

Inherited from EventEmitter.removeAllListeners

Overrides EventEmitter.removeAllListeners
- Defined in /home/hugo/Desktop/workhorse/node_modules/@types/node/index.d.ts:1033
Parameters
- Optional event: string | symbol
Returns this

Private removeCallFromPending

removeCallFromPending(callId: number): Call | void

- Defined in Farm.ts:113
Parameters
- callId: number
Returns Call | void

removeListener

removeListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.removeListener

Overrides EventEmitter.removeListener
- Defined in /home/hugo/Desktop/workhorse/node_modules/@types/node/index.d.ts:1031
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

Private rotateWorker

rotateWorker(id: number): void

- Defined in Farm.ts:194
Will remove a worker from the farm and create a new one

Parameters
- id: number
Returns void

run

run(...args: any[]): Promise<any>

- Defined in Farm.ts:37
Parameters
- Rest ...args: any[]
Returns Promise<any>

runMethod

runMethod(method?: undefined | string, ...args: any[]): Promise<any>

- Defined in Farm.ts:41
Parameters
- Optional method: undefined | string
- Rest ...args: any[]
Returns Promise<any>

setMaxListeners

setMaxListeners(n: number): this

Inherited from EventEmitter.setMaxListeners

Overrides EventEmitter.setMaxListeners
- Defined in /home/hugo/Desktop/workhorse/node_modules/@types/node/index.d.ts:1034
Parameters
- n: number
Returns this

Static listenerCount

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

Inherited from EventEmitter.listenerCount
- Defined in /home/hugo/Desktop/workhorse/node_modules/@types/node/index.d.ts:1023
deprecated

since v4.0.0

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

Generated using TypeDoc