Module

Defined in: core/src/module.ts:43

Module - Represents a worker process with configuration and communication.

Example

const worker = new Module('worker')
  .executable('python', ['worker.py'])
  .method('process', { codec: msgpackCodec })
  .event('progress');

// After manager.spawn():
const result = await worker.send('process', data);
worker.onEvent('progress', console.log);

Extends

• SpawnError<S, ChildProcess>

Type Parameters

S

S extends SpawnError = SpawnError

Constructors

Constructor

new Module<S>(): Module<S>

Returns

Module<S>

Inherited from

ModuleCore<S, ChildProcess>.constructor

Methods

event()

event<N, C>(name, config?): Module<AddEvent<S, N, C>>

Defined in: core/src/module.ts:97

Register an event.

Type Parameters

N

N extends string

C

C extends Codec = Codec

Parameters

name

N

config?

any

Returns

Module<AddEvent<S, N, C>>

---

method()

Register a method (implementation: shared core).

Call Signature

method<N, CReq, CRes, RT>(name, config): Module<AddMethod<S, N, CReq, CRes, RT>>

Defined in: core/src/module.ts:60

Register a method with dual codecs (full control).

Use when request and response need different codecs, or when using asymmetric codecs like Arrow.

Type Parameters

N

N extends string

CReq

CReq extends Codec

CRes

CRes extends Codec

RT

RT extends ResponseType = "result"

Parameters

name

N

config

any

Returns

Module<AddMethod<S, N, CReq, CRes, RT>>

Call Signature

method<N, C, RT>(name, config?): Module<AddMethodSymmetric<S, N, C, RT>>

Defined in: core/src/module.ts:73

Register a method with a single codec (symmetric shorthand).

Type Parameters

N

N extends string

C

C extends Codec = Codec

RT

RT extends ResponseType = "result"

Parameters

name

N

config?

any

Returns

Module<AddMethodSymmetric<S, N, C, RT>>