Welshman Docs / @welshman/lib / Worker
Class: Worker<T> ​
Defined in: packages/lib/src/Worker.ts:22
Worker for processing messages in batches with throttling
Type Parameters ​
• T
Type of messages to process
Constructors ​
new Worker() ​
new Worker<
T>(opts):Worker<T>
Defined in: packages/lib/src/Worker.ts:28
Parameters ​
opts ​
WorkerOpts<T> = {}
Returns ​
Worker<T>
Properties ​
buffer ​
buffer:
T[] =[]
Defined in: packages/lib/src/Worker.ts:23
handlers ​
handlers:
Map<any, (x) =>void[]>
Defined in: packages/lib/src/Worker.ts:24
opts ​
readonlyopts:WorkerOpts<T> ={}
Defined in: packages/lib/src/Worker.ts:28
Methods ​
addGlobalHandler() ​
addGlobalHandler(
handler):void
Defined in: packages/lib/src/Worker.ts:115
Adds a handler for all messages
Parameters ​
handler ​
(message) => void
Function to process all messages
Returns ​
void
addHandler() ​
addHandler(
k,handler):void
Defined in: packages/lib/src/Worker.ts:92
Adds a handler for messages with specific key
Parameters ​
k ​
any
Key to handle
handler ​
(message) => void
Function to process matching messages
Returns ​
void
clear() ​
clear():
void
Defined in: packages/lib/src/Worker.ts:128
Removes all pending messages from the queue
Returns ​
void
pause() ​
pause():
void
Defined in: packages/lib/src/Worker.ts:133
Pauses message processing
Returns ​
void
push() ​
push(
message):void
Defined in: packages/lib/src/Worker.ts:82
Adds a message to the processing queue
Parameters ​
message ​
T
Message to process
Returns ​
void
removeGlobalHandler() ​
removeGlobalHandler(
handler):void
Defined in: packages/lib/src/Worker.ts:123
Removes a handler for all messages
Parameters ​
handler ​
(message) => void
Function to process all messages
Returns ​
void
removeHandler() ​
removeHandler(
k,handler):void
Defined in: packages/lib/src/Worker.ts:101
Removes a handler for messages with specific key
Parameters ​
k ​
any
Key to handle
handler ​
(message) => void
Function to process matching messages
Returns ​
void
resume() ​
resume():
void
Defined in: packages/lib/src/Worker.ts:141
Resumes message processing
Returns ​
void