Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/duart38/thread
type safe multi-threading made easier
https://github.com/duart38/thread
deno module multithreading thread threading typesafe typescript webworker webworkers worker
Last synced: 3 months ago
JSON representation
type safe multi-threading made easier
- Host: GitHub
- URL: https://github.com/duart38/thread
- Owner: duart38
- License: mit
- Created: 2020-08-02T12:47:16.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-03-02T11:33:48.000Z (11 months ago)
- Last Synced: 2024-10-17T04:55:27.198Z (4 months ago)
- Topics: deno, module, multithreading, thread, threading, typesafe, typescript, webworker, webworkers, worker
- Language: TypeScript
- Homepage:
- Size: 111 KB
- Stars: 47
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
[](https://nest.land/package/Thread)
1. This module allows you to write **Web Worker** code inline with the rest of your code
2. This module is also somewhat type safe
3. Allows you to Thread already existing functions
5. Allows module imports inside the worker
## Examples
> See examples folder for more examples
```typescript
let thread = new Thread((e: MessageEvent)=>{
console.log('Worker: Message received from main script');
const result = e.data[0] * e.data[1];
if (isNaN(result)) {
return 0;
} else {
console.log('Worker: Posting message back to main script');
return(result);
}
}, "module");
thread.onMessage((e)=>{
console.log(`back from thread: ${e}`)
})
thread.postMessage([10, 12])
```
Instead of using the workers postMessage() method we return value from withing our method
**Here's a few more examples**
```typescript
function someFunction(e: MessageEvent){
return 0;
}
new Thread((e: MessageEvent)=>{return 0}, "module"); // inline Thread with return type of number
new Thread(someFunction, "module"); // thread an already existing function
new Thread(someFunction, "module", ['import Something from "../some.bundle.js";']); // thread with custom importing
```
**Async support**
```TypeScript
const thread = new Thread(async (_) => {
console.log("Worker: Message received from main script");
// Some async logic...
await new Promise((ir) => setTimeout(ir, 2000));
return "DONE";
}, "module");
thread.onMessage((e) => {
console.log(`recived back from thread: ${e}`);
});
thread.postMessage(0);
```
## API
### Standard API
| Method / variable | Description |
|------------------------------------ |----------------------------------------------------------------------------------------------------------------------------
| worker | The Worker. |
| stopped | Tells if the worker has been stopped |
| postMessage(msg) | Sends data to the Thread |
| stop() | calls terminate on the worker. |
| remove() | Removes the current worker file from the temporary folder. NOTE: Can be used while the program is running (calls stop()..) |
| onMessage(callback: (e: T) =>void) | Bind to the worker to receive messages |