easy-web-worker 6.1.0 → 6.1.1

package/README.md

@@ -30,7 +30,7 @@ const worker = createEasyWebWorker(({ onMessage }) => {
      * The payload includes whatever parameters are sent from the main thread
      */
     const { payload } = message;
-    const result = fibonacci(payload.base);
+    const result = fibonacci(payload.index);
 
     message.resolve(result);
     //message.reject(); // or reject
@@ -44,7 +44,7 @@ Then, for sending a message to the worker:
 /**
  * This returns a CancelablePromise
  */
-await worker.send(40);
+await worker.send({ index: 40 });
 ```
 
 And that's it! You now have a worker running heavy computation in a real separate thread, with real asynchronous programming in JavaScript.
@@ -52,11 +52,11 @@ And that's it! You now have a worker running heavy computation in a real separat
 You can also create an easy web worker from a static file, or from a native worker instance:
 
 ```ts
-const worker = createEasyWebWorker("./worker.js");
-const worker = createEasyWebWorker(new Worker("./worker.js")); // ƒ Worker() { [native code] }
+const worker = createEasyWebWorker('./worker.js');
+const worker = createEasyWebWorker(new Worker('./worker.js')); // ƒ Worker() { [native code] }
 
-const worker = new EasyWebWorker("./worker.js");
-const worker = new EasyWebWorker(new Worker("./worker.js")); // ƒ Worker() { [native code] }
+const worker = new EasyWebWorker('./worker.js');
+const worker = new EasyWebWorker(new Worker('./worker.js')); // ƒ Worker() { [native code] }
 ```
 
 When working with **static files**, which can offer substantial benefits with web workers, you simply need to create an instance of **StaticEasyWebWorker**.
@@ -84,15 +84,15 @@ onMessage((message) => {
 
   /** You can reject the message and send back a reason,
    * if no transfer is necessary just avoid the second parameter */
-  message.reject(new Error("something happened"));
+  message.reject(new Error('something happened'));
 
-  const metadata = { message: "progress from inside the worker" };
+  const metadata = { message: 'progress from inside the worker' };
 
   /** You can report progress */
   message.reportProgress(10, metadata, []); // all the methods allows you to send Transferable[]
 
   /** You can cancel an operation from within the worker */
-  message.cancel("the operating was canceled from the worker");
+  message.cancel('the operating was canceled from the worker');
 
   /** You can subscribe to the cancellation event of the message,
    * regardless of whether this cancellation is internal or external to the worker.*/
@@ -117,7 +117,7 @@ onMessage((message) => {
 /**
  * For adding specific actions
  */
-onMessage("readCSV", (message) => {
+onMessage('readCSV', (message) => {
   // do something
 });
 ```
@@ -182,7 +182,7 @@ await createEasyWebWorker<null, string>(({ onMessage }) => {
 If you need to pass a primitive parameter to the body of the worker, you can use the **primitiveParameters** configuration. This is an array of values that will be serialized and embedded into the worker's body.
 
 ```ts
-const message = "Hello";
+const message = 'Hello';
 
 await createEasyWebWorker<null, string>(
   ({ onMessage }, context) => {
@@ -193,7 +193,7 @@ await createEasyWebWorker<null, string>(
   {
     primitiveParameters: [message],
   }
-).send("hello!");
+).send('hello!');
 ```
 
 Take a look at Workers API if you don't know yet how they work: https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API,
@@ -460,9 +460,9 @@ const worker = createEasyWebWorker<string, string>(({ onMessage }) => {
   });
 });
 
-const messagePromise = worker.send("Hello!");
+const messagePromise = worker.send('Hello!');
 
-worker.reboot("Worker was restarted");
+worker.reboot('Worker was restarted');
 
 // The message promise will be rejected with the reason 'Worker was restarted'
 ```

package/lib/EasyWebWorkerFixtures.d.ts

@@ -4,6 +4,7 @@ export declare const generatedId: () => string;
  * this template is used to create dynamic workers from strings templates
  * PLEASE KEEP THIS FUNCTION UPDATED WITH THE LATEST VERSION OF THE StaticEasyWebWorker CLASS
  * [IMPORTANT] Avoid ";" at the end of the template
+ * for transpiling you can use https://johnny-quesada-developer.github.io/easy-web-workers-example/?example=typescript
  * for minifying the template, please use the following options:
  * - remove comments
  * - remove types

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "easy-web-worker",
-  "version": "6.1.0",
+  "version": "6.1.1",
   "description": "This is a library to easily handle and create web-workers, if you are a web developer and never tried this... do not wait any longer! Workers are an amazing option to improve user experience and make your webpages even greater",
   "main": "lib/bundle.js",
   "types": "lib/index.d.ts",