Enhancing method docs

Author: ori88c

dist/zero-backpressure-semaphore.d.ts

@@ -88,6 +88,10 @@ export declare class ZeroBackpressureSemaphore<T, UncaughtErrorType = Error> {
      * This method is particularly useful for executing multiple or background jobs, where no return
      * value is expected.
      *
+     * If the job throws an error, it is captured by the semaphore and can be accessed via the
+     * `extractUncaughtError` method. Users are encouraged to specify a custom `UncaughtErrorType`
+     * generic parameter to the class if jobs may throw errors.
+     *
      * @param job - The job to be executed once the semaphore is available.
      * @returns A promise that resolves when the job starts execution.
      */
@@ -109,6 +113,7 @@ export declare class ZeroBackpressureSemaphore<T, UncaughtErrorType = Error> {
      * or rejects, you can continue the route handler's flow based on the result.
      *
      * @param job - The job to be executed once the semaphore is available.
+     * @throws - Error thrown by the job itself.
      * @returns A promise that resolves with the job's return value or rejects with its error.
      */
     waitForCompletion(job: SemaphoreJob<T>): Promise<T>;

dist/zero-backpressure-semaphore.js

@@ -133,6 +133,10 @@ export class ZeroBackpressureSemaphore<T, UncaughtErrorType = Error> {
      * This method is particularly useful for executing multiple or background jobs, where no return
      * value is expected.
      * 
+     * If the job throws an error, it is captured by the semaphore and can be accessed via the
+     * `extractUncaughtError` method. Users are encouraged to specify a custom `UncaughtErrorType`
+     * generic parameter to the class if jobs may throw errors.
+     * 
      * @param job - The job to be executed once the semaphore is available.
      * @returns A promise that resolves when the job starts execution.
      */	
@@ -159,6 +163,7 @@ export class ZeroBackpressureSemaphore<T, UncaughtErrorType = Error> {
      * or rejects, you can continue the route handler's flow based on the result.
      * 
      * @param job - The job to be executed once the semaphore is available.
+     * @throws - Error thrown by the job itself.
      * @returns A promise that resolves with the job's return value or rejects with its error.
      */
     public async waitForCompletion(job: SemaphoreJob<T>): Promise<T> {