node-thread-decorator 1.0.3 → 1.0.4

package/README.md

@@ -8,7 +8,7 @@
 ### Install
 
 ```
-$ npm i -S node-thread-decorator
+ npm i -S node-thread-decorator
 ```
 
 ### Usage
@@ -18,18 +18,17 @@ $ npm i -S node-thread-decorator
 ```ts
 import { RunInNewThread } from "node-thread-decorator";
 ```
-
+- Usage
 ```ts
 import { Controller, Get } from '@nestjs/common';
 
 import { RunInNewThread } from 'node-thread-decorator';
-import { IHealthAdapter } from './adapter';
 
 @Controller()
 export class HealthController {
   /**
    * Blocks the main thread for a specified duration in milliseconds.
-   * This function runs in a new process due to the decorator `@RunInNewProcess`.
+   * This function runs in a new process due to the decorator `@RunInNewThread`.
    *
    * @param {number} milliseconds - The time to block the thread in milliseconds.
    */
@@ -39,7 +38,6 @@ export class HealthController {
     while (Date.now() - start < milliseconds) {
       // Looping until time has passed
     }
-    console.log("Finished new process", process.pid);
   }
 
   /**
@@ -50,12 +48,12 @@ export class HealthController {
    */
   @Get(['/health', '/'])
   async getHealth(): Promise<string> {
-    console.log("Started process", process.pid);
     this.blockMainThread(10000); // Simulating blocking the thread for 10 seconds
     console.log("Health check completed");
     return "APP UP!"
   }
 }
+```
 
 ---
 
@@ -66,4 +64,4 @@ The following is a list of all the people that have contributed Node Thread Deco
 ## License
 
 It is available under the MIT license.
-[License](https://opensource.org/licenses/mit-license.php)
+[License](https://opensource.org/licenses/mit-license.php)

package/dist/thread.decorator.d.ts

@@ -1 +1,23 @@
-export declare function RunInNewThread(timeout?: number): (target: object, key: string, descriptor: PropertyDescriptor) => PropertyDescriptor;
+/**
+ * Decorator that executes a method in a new thread.
+ *
+ * This decorator utilizes `worker_threads` to execute the target method in a separate thread, 
+ * improving performance for CPU-intensive tasks without blocking the main event loop.
+ * Optionally, a timeout can be specified to terminate the thread if it exceeds the given time.
+ *
+ * @param timeout - (Optional) The maximum execution time in milliseconds before the thread is terminated. 
+ *                  If not provided, the thread runs without a timeout.
+ * @returns A method decorator that modifies the method to execute in a new thread.
+ *
+ * @example
+ * ```typescript
+ * class TaskProcessor {
+ *   @RunInNewThread(5000) // Runs in a new thread with a 5-second timeout
+ *   heavyComputation() {
+ *     // CPU-intensive task
+ *   }
+ * }
+ * ```
+ */
+export declare function RunInNewThread(timeout?: number): 
+  (target: object, key: string, descriptor: PropertyDescriptor) => PropertyDescriptor;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-thread-decorator",
-  "version": "1.0.3",
+  "version": "1.0.4",
   "description": "node thread decorator",
   "main": "dist/thread.decorator.js",
   "types": "dist/thread.decorator.d.ts",