murlock 2.0.0 → 2.0.1

package/README.md

@@ -70,6 +70,7 @@ export class AppService {
 ```
 
 If there are multiple wrapped parameter, you can call it by {index of parameter}.{parameter name} as it shown
+
 ```typescript
 import { MurLock } from 'murlock';
 
@@ -114,6 +115,82 @@ In the example above, the `ConfigModule` and `ConfigService` are used to provide
 
 For more details on usage and configuration, please refer to the API documentation below.
 
+## Using `MurLockService` Directly
+
+While the `@MurLock()` decorator provides a convenient and declarative way to handle locking within your NestJS application, there may be cases where you need more control over the lock lifecycle. For such cases, `MurLockService` offers a programmatic way to manage locks.
+
+#### Injecting `MurLockService`
+
+First, inject `MurLockService` into your service:
+
+```typescript
+import { Injectable } from '@nestjs/common';
+import { MurLockService } from 'murlock';
+
+@Injectable()
+export class YourService {
+  constructor(private murLockService: MurLockService) {}
+  
+  // Your methods where you want to use the lock
+}
+```
+
+#### Acquiring a Lock
+
+You can acquire a lock by calling the `acquireLock` method with a unique `lockKey` and the desired `lockTime`:
+
+```typescript
+async performTaskWithLock() {
+  const lockKey = 'unique_lock_key';
+  const lockTime = 3000; // Duration for which the lock should be held in milliseconds
+
+  try {
+    await this.murLockService.acquireLock(lockKey, lockTime);
+    // Proceed with the operation that requires the lock
+  } catch (error) {
+    // Handle the error if the lock could not be acquired
+    throw error;
+  } finally {
+    // Make sure to release the lock
+    await this.murLockService.releaseLock(lockKey);
+  }
+}
+```
+
+#### Releasing a Lock
+
+To release a lock, use the `releaseLock` method:
+
+```typescript
+await this.murLockService.releaseLock(lockKey);
+```
+
+#### Handling Errors
+
+Make sure to handle exceptions gracefully, especially when you are unable to acquire a lock:
+
+```typescript
+try {
+  // Lock acquisition attempts
+} catch (error) {
+  // Error handling logic
+} finally {
+  // Always release the lock in a finally block
+}
+```
+
+#### Best Practices and Considerations
+
+- Always release locks in a `finally` block to avoid deadlocks.
+- Use meaningful lock keys that are unique to the resources they represent.
+- Keep lock durations as short as possible to prevent system blockage.
+
+Directly using `MurLockService` gives you finer control over lock management but also increases the responsibility to ensure locks are correctly managed throughout your application's lifecycle.
+
+---
+
+This refined section is suitable for developers looking for documentation on using `MurLockService` directly in their projects and adheres to the typical conventions found in README files for open-source projects.
+
 ## API Documentation
 
 ### MurLock(releaseTime: number, ...keyParams: string[])
@@ -155,7 +232,7 @@ This project is licensed under the [MIT License](https://github.com/felanios/mur
 
 ## Contact
 
-If you have any questions or feedback, feel free to contact me at ozmen.eyupfurkan@gmail.com.
+If you have any questions or feedback, feel free to contact me at <ozmen.eyupfurkan@gmail.com>.
 
 ---
 

package/dist/murlock.module.js

@@ -66,7 +66,12 @@ exports.MurLockModule = MurLockModule;
 exports.MurLockModule = MurLockModule = MurLockModule_1 = __decorate([
     (0, common_1.Global)(),
     (0, common_1.Module)({
-        imports: [nestjs_cls_1.ClsModule],
+        imports: [
+            nestjs_cls_1.ClsModule.forRoot({
+                global: true,
+                middleware: { mount: true },
+            }),
+        ],
         providers: [murlock_service_1.MurLockService],
         exports: [murlock_service_1.MurLockService],
     })

package/dist/murlock.module.js.map

@@ -1 +1 @@
-{"version":3,"file":"murlock.module.js","sourceRoot":"","sources":["../lib/murlock.module.ts"],"names":[],"mappings":";;;;;;;;;;AAAA,2CAAyE;AACzE,uDAAmD;AACnD,4BAA0B;AAE1B,2CAA2D;AAC3D,2CAAuC;AAQhC,IAAM,aAAa,qBAAnB,MAAM,aAAa;IACxB,MAAM,CAAC,YAAY,CAAC,OAA6B;QAC/C,OAAO;YACL,MAAM,EAAE,eAAa;YACrB,SAAS,EAAE;gBACT;oBACE,OAAO,EAAE,iBAAiB;oBAC1B,QAAQ,EAAE,OAAO;iBAClB;gBACD,gCAAc;gBACd;oBACE,OAAO,EAAE,wCAA4B;oBACrC,UAAU,EAAE,CAAC,cAA8B,EAAE,EAAE;wBAC7C,OAAO,CAAC,cAAc,CAAC,wCAA4B,EAAE,cAAc,EAAE,gCAAc,CAAC,CAAC;wBACrF,OAAO,cAAc,CAAC;oBACxB,CAAC;oBACD,MAAM,EAAE,CAAC,gCAAc,CAAC;iBACzB;aACF;YACD,OAAO,EAAE,CAAC,gCAAc,CAAC;SAC1B,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,aAAa,CAAC,OAAkC;QACrD,OAAO;YACL,MAAM,EAAE,eAAa;YACrB,OAAO,EAAE,OAAO,CAAC,OAAO,IAAI,EAAE;YAC9B,SAAS,EAAE;gBACT,IAAI,CAAC,0BAA0B,CAAC,OAAO,CAAC;gBACxC,gCAAc;gBACd;oBACE,OAAO,EAAE,wCAA4B;oBACrC,UAAU,EAAE,CAAC,cAA8B,EAAE,EAAE;wBAC7C,OAAO,CAAC,cAAc,CAAC,wCAA4B,EAAE,cAAc,EAAE,gCAAc,CAAC,CAAC;wBACrF,OAAO,cAAc,CAAC;oBACxB,CAAC;oBACD,MAAM,EAAE,CAAC,gCAAc,CAAC;iBACzB;aACF;YACD,OAAO,EAAE,CAAC,gCAAc,CAAC;SAC1B,CAAC;IACJ,CAAC;IAEO,MAAM,CAAC,0BAA0B,CAAC,OAAkC;QAC1E,OAAO;YACL,OAAO,EAAE,iBAAiB;YAC1B,UAAU,EAAE,OAAO,CAAC,UAAU;YAC9B,MAAM,EAAE,OAAO,CAAC,MAAM,IAAI,EAAE;SAC7B,CAAC;IACJ,CAAC;CACF,CAAA;AAlDY,sCAAa;wBAAb,aAAa;IANzB,IAAA,eAAM,GAAE;IACR,IAAA,eAAM,EAAC;QACN,OAAO,EAAE,CAAC,sBAAS,CAAC;QACpB,SAAS,EAAE,CAAC,gCAAc,CAAC;QAC3B,OAAO,EAAE,CAAC,gCAAc,CAAC;KAC1B,CAAC;GACW,aAAa,CAkDzB"}
+{"version":3,"file":"murlock.module.js","sourceRoot":"","sources":["../lib/murlock.module.ts"],"names":[],"mappings":";;;;;;;;;;AAAA,2CAAyE;AACzE,uDAAmD;AACnD,4BAA0B;AAE1B,2CAA2D;AAC3D,2CAAuC;AAahC,IAAM,aAAa,qBAAnB,MAAM,aAAa;IACxB,MAAM,CAAC,YAAY,CAAC,OAA6B;QAC/C,OAAO;YACL,MAAM,EAAE,eAAa;YACrB,SAAS,EAAE;gBACT;oBACE,OAAO,EAAE,iBAAiB;oBAC1B,QAAQ,EAAE,OAAO;iBAClB;gBACD,gCAAc;gBACd;oBACE,OAAO,EAAE,wCAA4B;oBACrC,UAAU,EAAE,CAAC,cAA8B,EAAE,EAAE;wBAC7C,OAAO,CAAC,cAAc,CAAC,wCAA4B,EAAE,cAAc,EAAE,gCAAc,CAAC,CAAC;wBACrF,OAAO,cAAc,CAAC;oBACxB,CAAC;oBACD,MAAM,EAAE,CAAC,gCAAc,CAAC;iBACzB;aACF;YACD,OAAO,EAAE,CAAC,gCAAc,CAAC;SAC1B,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,aAAa,CAAC,OAAkC;QACrD,OAAO;YACL,MAAM,EAAE,eAAa;YACrB,OAAO,EAAE,OAAO,CAAC,OAAO,IAAI,EAAE;YAC9B,SAAS,EAAE;gBACT,IAAI,CAAC,0BAA0B,CAAC,OAAO,CAAC;gBACxC,gCAAc;gBACd;oBACE,OAAO,EAAE,wCAA4B;oBACrC,UAAU,EAAE,CAAC,cAA8B,EAAE,EAAE;wBAC7C,OAAO,CAAC,cAAc,CAAC,wCAA4B,EAAE,cAAc,EAAE,gCAAc,CAAC,CAAC;wBACrF,OAAO,cAAc,CAAC;oBACxB,CAAC;oBACD,MAAM,EAAE,CAAC,gCAAc,CAAC;iBACzB;aACF;YACD,OAAO,EAAE,CAAC,gCAAc,CAAC;SAC1B,CAAC;IACJ,CAAC;IAEO,MAAM,CAAC,0BAA0B,CAAC,OAAkC;QAC1E,OAAO;YACL,OAAO,EAAE,iBAAiB;YAC1B,UAAU,EAAE,OAAO,CAAC,UAAU;YAC9B,MAAM,EAAE,OAAO,CAAC,MAAM,IAAI,EAAE;SAC7B,CAAC;IACJ,CAAC;CACF,CAAA;AAlDY,sCAAa;wBAAb,aAAa;IAXzB,IAAA,eAAM,GAAE;IACR,IAAA,eAAM,EAAC;QACN,OAAO,EAAE;YACP,sBAAS,CAAC,OAAO,CAAC;gBAChB,MAAM,EAAE,IAAI;gBACZ,UAAU,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE;aAC5B,CAAC;SACH;QACD,SAAS,EAAE,CAAC,gCAAc,CAAC;QAC3B,OAAO,EAAE,CAAC,gCAAc,CAAC;KAC1B,CAAC;GACW,aAAa,CAkDzB"}