asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

chore(types): small fixes to locking TSDocs (#11823)

Browse Source 
* chore(types): small fixes to locking TSDocs

* add missing return
This commit is contained in:
Shahed Nasser
2025-03-12 16:31:07 +02:00
committed by GitHub
parent 72d2cf9207
commit 76a0d8e1d8
1 changed files with 7 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/core/types/src/locking/index.ts
+7 -2
View File
@@ -19,7 +19,7 @@ import { Context } from "../shared-context"
* } * }
* *
* type Options = { * type Options = {
* apiKey: string * url: string
* } * }
* *
* class MyLockingProviderService implements ILockingProvider { * class MyLockingProviderService implements ILockingProvider {
@@ -54,7 +54,7 @@ import { Context } from "../shared-context"
* For example: * For example:
* *
* ```ts * ```ts
* class MyLockingProviderService extends ILockingProvider { * class MyLockingProviderService implements ILockingProvider {
* static identifier = "my-lock" * static identifier = "my-lock"
* // ... * // ...
* } * }
@@ -73,6 +73,7 @@ export interface ILockingProvider {
* @param args - Additional arguments for the job execution. * @param args - Additional arguments for the job execution.
* @param sharedContext - A context used to share resources, such as transaction manager, between the application and the module. * @param sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
* @returns The result of the job. * @returns The result of the job.
* @typeParam T - The type of the job's result.
* *
* @example * @example
* An example of how to implement the `execute` method: * An example of how to implement the `execute` method:
@@ -169,6 +170,7 @@ export interface ILockingProvider {
* @param keys - The keys to acquire the lock on. * @param keys - The keys to acquire the lock on.
* @param args - Additional arguments for acquiring the lock. * @param args - Additional arguments for acquiring the lock.
* @param sharedContext - A context used to share resources, such as transaction manager, between the application and the module. * @param sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
* @returns Resolves when the lock is acquired.
* *
* @example * @example
* An example of how to implement the `acquire` method: * An example of how to implement the `acquire` method:
@@ -250,6 +252,7 @@ export interface ILockingProvider {
* @param keys - The keys to release the lock from. * @param keys - The keys to release the lock from.
* @param args - Additional arguments for releasing the lock. * @param args - Additional arguments for releasing the lock.
* @param sharedContext - A context used to share resources, such as transaction manager, between the application and the module. * @param sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
* @returns Whether the lock was successfully released. If the lock has a different owner than the one passed, the method returns `false`.
* *
* @example * @example
* An example of how to implement the `release` method: * An example of how to implement the `release` method:
@@ -346,6 +349,7 @@ export interface ILockingModule {
* @param args - Additional arguments for the job execution. * @param args - Additional arguments for the job execution.
* @param sharedContext - A context used to share resources, such as transaction manager, between the application and the module. * @param sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
* @returns The result of the job execution. * @returns The result of the job execution.
* @typeParam T - The type of the job's result.
* *
* @example * @example
* For example, to use the lock module when deleting a product: * For example, to use the lock module when deleting a product:
@@ -397,6 +401,7 @@ export interface ILockingModule {
* @param keys - The keys to acquire the lock on. * @param keys - The keys to acquire the lock on.
* @param args - Additional arguments for acquiring the lock. * @param args - Additional arguments for acquiring the lock.
* @param sharedContext - A context used to share resources, such as transaction manager, between the application and the module. * @param sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
* @returns Resolves when the lock is acquired.
* *
* @example * @example
* For example, to acquire a lock on a product with ID `prod_123` for a user with ID `user_123`: * For example, to acquire a lock on a product with ID `prod_123` for a user with ID `user_123`: