worker_map

A simple abstraction for Node.js worker_threads, allowing you to create and share a Map (hash table) between worker threads and the main process. This simplifies the process of managing shared data and communication between worker threads.


Under the hood, the library uses SharedArrayBuffer to create shared memory, enabling seamless data sharing between threads. Additionally, it uses Atomics mechanism to implement a mutex, ensuring thread safety and preventing race conditions during data access and manipulation.

Installation

``
npm i worker_map
`

Basic Example

First, let's create a simple hash map structure in main process, then create a worker thread and share the hash.

`js
// main.js
const { Worker } = require("worker_threads");
const { WorkerMap } = require("worker_map");

const map = new WorkerMap();
map.set("balance", 100); // sync operation

new Worker("./worker.js", {
workerData: {
mapBuffer: map.toSharedBuffer(),
},
});

setTimeout(() => {
console.log(map.get("balance")); // 200
}, 50);
`

Now, let's access the shared hash map structure in the worker thread.

`js
// worker.js
const { WorkerMap } = require("worker_map");
const { workerData } = require("worker_threads");

const map = new WorkerMap(workerData.mapBuffer);
console.log(map.get("balance")); // 100

// The change will be reflected in the main process as well
map.set("balance", 200);
`

Instance methods

Worker_map is much like JavaScript's regular Map.

$3

`js
map.set('name', 'John'); // true
`

$3

`js
const name = map.get('name'); // 'John'
`

$3

`js
map.delete('name'); // true
map.delete('something'); // false because it doesn't exist
`

$3

`js
map.clear();
map.size(); // 0
`

$3

`js
map.has('name'); // true
map.has('country'); // false
`

$3

`js
map.has('size'); // 1
`

$3

`js
map.keys(); // [ 'name' ]
`

$3

`js
for (const [ key, value ] of map.entries()) {
console.log(${key}: ${value}); // name: 'John'
}
`

$3

`js
map.forEach(function(key, value, map) {
console.log(${key}: ${value}); // name: 'John'
});
`

$3

`js
const buffer = map.toSharedBuffer();
const sameMap = new WorkerMap(buffer);
`

$3

`js
const mapObject = map.toObject(); // { ... }
mapObject.name; // 'John'
``

Contributing

See the contributing guide for detailed instructions on how to get started with our project.

TODO

- Currently, when performing an action on the map, it temporarily locks the entire map, loads the necessary data, and then unlocks the map, allowing other threads to access it. However, this approach is suboptimal. It would be more efficient if we could lock only the specific portion of memory required for the particular operation.

Limitations

Please be aware of the following limitations when using our library:

1. Functions: Function types are not supported.
2. NaN Values: NaN values are not supported.