Skip to content

Commit 71859a0

Browse files
committed
docs: minor
1 parent 773e3bf commit 71859a0

2 files changed

Lines changed: 3 additions & 3 deletions

File tree

packages/verrou/src/errors.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ export const E_LOCK_STORAGE_ERROR = createError<[{ message: string }]>(
2525
)
2626

2727
/**
28-
* Thrown when the lock is already acquired by someone else
28+
* Thrown when user tries to acquire a lock that is already acquired by someone else
2929
*/
3030
export const E_LOCK_ALREADY_ACQUIRED = createError(
3131
'Lock is already acquired',

packages/verrou/src/verrou.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ import { LockFactory } from './lock_factory.js'
44
import type { Duration, SerializedLock, StoreFactory } from './types/main.js'
55

66
/**
7-
* Verrou is the main class of the library. It is used to create locks
8-
* and to access the underlying stores.
7+
* Verrou provides a lock management for multiple stores.
8+
* It allows accessing and manipulating locks in different stores
99
*/
1010
export class Verrou<KnownStores extends Record<string, StoreFactory>> {
1111
/**

0 commit comments

Comments
 (0)