@lickle/lock 0.0.1-alpha.1 → 0.0.1-alpha.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (91) hide show
  1. package/README.md +182 -76
  2. package/cjs.js +57 -57
  3. package/dist/cjs/core/guard.d.ts +50 -0
  4. package/dist/cjs/core/guard.d.ts.map +1 -0
  5. package/dist/cjs/{backend → core}/guard.js +43 -11
  6. package/dist/cjs/core/guard.js.map +1 -0
  7. package/dist/cjs/core/index.d.ts +8 -0
  8. package/dist/cjs/core/index.d.ts.map +1 -0
  9. package/dist/cjs/core/index.js +41 -0
  10. package/dist/cjs/core/index.js.map +1 -0
  11. package/dist/cjs/core/locking.d.ts +23 -0
  12. package/dist/cjs/core/locking.d.ts.map +1 -0
  13. package/dist/cjs/core/locking.js +93 -0
  14. package/dist/cjs/core/locking.js.map +1 -0
  15. package/dist/cjs/core/node.d.ts +19 -0
  16. package/dist/cjs/core/node.d.ts.map +1 -0
  17. package/dist/cjs/core/node.js +69 -0
  18. package/dist/cjs/core/node.js.map +1 -0
  19. package/dist/cjs/core/types.d.ts +49 -0
  20. package/dist/cjs/core/types.d.ts.map +1 -0
  21. package/dist/cjs/core/types.js +13 -0
  22. package/dist/cjs/core/types.js.map +1 -0
  23. package/dist/cjs/index.d.ts +43 -34
  24. package/dist/cjs/index.d.ts.map +1 -1
  25. package/dist/cjs/index.js +59 -39
  26. package/dist/cjs/index.js.map +1 -1
  27. package/dist/esm/core/guard.d.ts +50 -0
  28. package/dist/esm/core/guard.d.ts.map +1 -0
  29. package/dist/esm/{backend → core}/guard.js +40 -9
  30. package/dist/esm/core/guard.js.map +1 -0
  31. package/dist/esm/core/index.d.ts +8 -0
  32. package/dist/esm/core/index.d.ts.map +1 -0
  33. package/dist/esm/core/index.js +21 -0
  34. package/dist/esm/core/index.js.map +1 -0
  35. package/dist/esm/core/locking.d.ts +23 -0
  36. package/dist/esm/core/locking.d.ts.map +1 -0
  37. package/dist/esm/core/locking.js +56 -0
  38. package/dist/esm/core/locking.js.map +1 -0
  39. package/dist/esm/core/node.d.ts +19 -0
  40. package/dist/esm/core/node.d.ts.map +1 -0
  41. package/dist/esm/core/node.js +61 -0
  42. package/dist/esm/core/node.js.map +1 -0
  43. package/dist/esm/core/types.d.ts +49 -0
  44. package/dist/esm/core/types.d.ts.map +1 -0
  45. package/dist/esm/core/types.js +9 -0
  46. package/dist/esm/core/types.js.map +1 -0
  47. package/dist/esm/index.d.ts +43 -34
  48. package/dist/esm/index.d.ts.map +1 -1
  49. package/dist/esm/index.js +53 -34
  50. package/dist/esm/index.js.map +1 -1
  51. package/esm.js +58 -58
  52. package/index.d.ts +32 -8
  53. package/package.json +6 -6
  54. package/dist/cjs/backend/guard.d.ts +0 -31
  55. package/dist/cjs/backend/guard.d.ts.map +0 -1
  56. package/dist/cjs/backend/guard.js.map +0 -1
  57. package/dist/cjs/backend/index.d.ts +0 -8
  58. package/dist/cjs/backend/index.d.ts.map +0 -1
  59. package/dist/cjs/backend/index.js +0 -31
  60. package/dist/cjs/backend/index.js.map +0 -1
  61. package/dist/cjs/backend/lockable.d.ts +0 -15
  62. package/dist/cjs/backend/lockable.d.ts.map +0 -1
  63. package/dist/cjs/backend/lockable.js +0 -76
  64. package/dist/cjs/backend/lockable.js.map +0 -1
  65. package/dist/cjs/backend/node.d.ts +0 -36
  66. package/dist/cjs/backend/node.d.ts.map +0 -1
  67. package/dist/cjs/backend/node.js +0 -118
  68. package/dist/cjs/backend/node.js.map +0 -1
  69. package/dist/cjs/backend/types.d.ts +0 -36
  70. package/dist/cjs/backend/types.d.ts.map +0 -1
  71. package/dist/cjs/backend/types.js +0 -3
  72. package/dist/cjs/backend/types.js.map +0 -1
  73. package/dist/esm/backend/guard.d.ts +0 -31
  74. package/dist/esm/backend/guard.d.ts.map +0 -1
  75. package/dist/esm/backend/guard.js.map +0 -1
  76. package/dist/esm/backend/index.d.ts +0 -8
  77. package/dist/esm/backend/index.d.ts.map +0 -1
  78. package/dist/esm/backend/index.js +0 -13
  79. package/dist/esm/backend/index.js.map +0 -1
  80. package/dist/esm/backend/lockable.d.ts +0 -15
  81. package/dist/esm/backend/lockable.d.ts.map +0 -1
  82. package/dist/esm/backend/lockable.js +0 -39
  83. package/dist/esm/backend/lockable.js.map +0 -1
  84. package/dist/esm/backend/node.d.ts +0 -36
  85. package/dist/esm/backend/node.d.ts.map +0 -1
  86. package/dist/esm/backend/node.js +0 -109
  87. package/dist/esm/backend/node.js.map +0 -1
  88. package/dist/esm/backend/types.d.ts +0 -36
  89. package/dist/esm/backend/types.d.ts.map +0 -1
  90. package/dist/esm/backend/types.js +0 -2
  91. package/dist/esm/backend/types.js.map +0 -1
@@ -0,0 +1,19 @@
1
+ import fs from 'node:fs';
2
+ import { type Fs, FileDescriptor } from './types.js';
3
+ import { type LockHooks } from './locking.js';
4
+ /** Node.js file handle type alias. */
5
+ export type NodeFileHandle = fs.promises.FileHandle;
6
+ /** Create a Node.js filesystem that opens files with appropriate flags for the lock type. */
7
+ export declare const createNodeFs: () => Fs<NodeFileHandle>;
8
+ /**
9
+ * Track active locks by file descriptor and ensure they are released on process exit.
10
+ */
11
+ export declare class NodeLockHooks implements LockHooks {
12
+ private _active;
13
+ register(fd: FileDescriptor): Promise<void>;
14
+ unregister(fd: FileDescriptor): Promise<void>;
15
+ private _listen;
16
+ private _unlisten;
17
+ private _onExit;
18
+ }
19
+ //# sourceMappingURL=node.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"node.d.ts","sourceRoot":"","sources":["../../../lib/core/node.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,SAAS,CAAA;AAExB,OAAO,EAAE,KAAK,EAAE,EAAQ,cAAc,EAAa,MAAM,YAAY,CAAA;AACrE,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,cAAc,CAAA;AAE7C,sCAAsC;AACtC,MAAM,MAAM,cAAc,GAAG,EAAE,CAAC,QAAQ,CAAC,UAAU,CAAA;AAEnD,6FAA6F;AAC7F,eAAO,MAAM,YAAY,QAAO,EAAE,CAAC,cAAc,CAQhD,CAAA;AAED;;GAEG;AACH,qBAAa,aAAc,YAAW,SAAS;IAC7C,OAAO,CAAC,OAAO,CAA4B;IAErC,QAAQ,CAAC,EAAE,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IAM3C,UAAU,CAAC,EAAE,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IAWnD,OAAO,CAAC,OAAO;IAKf,OAAO,CAAC,SAAS;IAKjB,OAAO,CAAC,OAAO,CASd;CACF"}
@@ -0,0 +1,69 @@
1
+ "use strict";
2
+ var __importDefault = (this && this.__importDefault) || function (mod) {
3
+ return (mod && mod.__esModule) ? mod : { "default": mod };
4
+ };
5
+ Object.defineProperty(exports, "__esModule", { value: true });
6
+ exports.NodeLockHooks = exports.createNodeFs = void 0;
7
+ const node_worker_threads_1 = require("node:worker_threads");
8
+ const node_fs_1 = __importDefault(require("node:fs"));
9
+ const types_js_1 = require("./types.js");
10
+ /** Create a Node.js filesystem that opens files with appropriate flags for the lock type. */
11
+ const createNodeFs = () => {
12
+ return {
13
+ async open(file, type) {
14
+ const flags = type === types_js_1.Lock.Exclusive ? node_fs_1.default.constants.O_CREAT | node_fs_1.default.constants.O_RDWR : node_fs_1.default.constants.O_RDONLY;
15
+ const handle = await node_fs_1.default.promises.open(file, flags);
16
+ return handle;
17
+ },
18
+ };
19
+ };
20
+ exports.createNodeFs = createNodeFs;
21
+ /**
22
+ * Track active locks by file descriptor and ensure they are released on process exit.
23
+ */
24
+ class NodeLockHooks {
25
+ _active = new Map();
26
+ async register(fd) {
27
+ if (this._active.size === 0)
28
+ this._listen();
29
+ const d = (0, types_js_1.resolveFd)(fd);
30
+ this._active.set(d, (this._active.get(d) ?? 0) + 1);
31
+ }
32
+ async unregister(fd) {
33
+ const d = (0, types_js_1.resolveFd)(fd);
34
+ const count = this._active.get(d);
35
+ if (count !== undefined) {
36
+ if (count <= 1)
37
+ this._active.delete(d);
38
+ else
39
+ this._active.set(d, count - 1);
40
+ }
41
+ if (this._active.size === 0)
42
+ this._unlisten();
43
+ }
44
+ _listen() {
45
+ if (node_worker_threads_1.isMainThread)
46
+ process.on('exit', this._onExit);
47
+ else
48
+ node_worker_threads_1.parentPort?.on('close', this._onExit);
49
+ }
50
+ _unlisten() {
51
+ if (node_worker_threads_1.isMainThread)
52
+ process.off('exit', this._onExit);
53
+ else
54
+ node_worker_threads_1.parentPort?.off('close', this._onExit);
55
+ }
56
+ _onExit = () => {
57
+ for (const fd of Array.from(this._active.keys()).reverse()) {
58
+ try {
59
+ node_fs_1.default.closeSync(fd);
60
+ }
61
+ catch {
62
+ // EBADF expected if already closed
63
+ }
64
+ }
65
+ this._active.clear();
66
+ };
67
+ }
68
+ exports.NodeLockHooks = NodeLockHooks;
69
+ //# sourceMappingURL=node.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"node.js","sourceRoot":"","sources":["../../../lib/core/node.ts"],"names":[],"mappings":";;;;;;AAAA,6DAA8D;AAC9D,sDAAwB;AAExB,yCAAqE;AAMrE,6FAA6F;AACtF,MAAM,YAAY,GAAG,GAAuB,EAAE;IACnD,OAAO;QACL,KAAK,CAAC,IAAI,CAAC,IAAY,EAAE,IAAU;YACjC,MAAM,KAAK,GAAG,IAAI,KAAK,eAAI,CAAC,SAAS,CAAC,CAAC,CAAC,iBAAE,CAAC,SAAS,CAAC,OAAO,GAAG,iBAAE,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,iBAAE,CAAC,SAAS,CAAC,QAAQ,CAAA;YAC1G,MAAM,MAAM,GAAG,MAAM,iBAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,CAAA;YAClD,OAAO,MAAM,CAAA;QACf,CAAC;KACF,CAAA;AACH,CAAC,CAAA;AARY,QAAA,YAAY,gBAQxB;AAED;;GAEG;AACH,MAAa,aAAa;IAChB,OAAO,GAAG,IAAI,GAAG,EAAkB,CAAA;IAE3C,KAAK,CAAC,QAAQ,CAAC,EAAkB;QAC/B,IAAI,IAAI,CAAC,OAAO,CAAC,IAAI,KAAK,CAAC;YAAE,IAAI,CAAC,OAAO,EAAE,CAAA;QAC3C,MAAM,CAAC,GAAG,IAAA,oBAAS,EAAC,EAAE,CAAC,CAAA;QACvB,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAA;IACrD,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,EAAkB;QACjC,MAAM,CAAC,GAAG,IAAA,oBAAS,EAAC,EAAE,CAAC,CAAA;QACvB,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAA;QACjC,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,IAAI,KAAK,IAAI,CAAC;gBAAE,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAA;;gBACjC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,GAAG,CAAC,CAAC,CAAA;QACrC,CAAC;QAED,IAAI,IAAI,CAAC,OAAO,CAAC,IAAI,KAAK,CAAC;YAAE,IAAI,CAAC,SAAS,EAAE,CAAA;IAC/C,CAAC;IAEO,OAAO;QACb,IAAI,kCAAY;YAAE,OAAO,CAAC,EAAE,CAAC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,CAAA;;YAC7C,gCAAU,EAAE,EAAE,CAAC,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,CAAA;IAC5C,CAAC;IAEO,SAAS;QACf,IAAI,kCAAY;YAAE,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,CAAA;;YAC9C,gCAAU,EAAE,GAAG,CAAC,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,CAAA;IAC7C,CAAC;IAEO,OAAO,GAAG,GAAS,EAAE;QAC3B,KAAK,MAAM,EAAE,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC;YAC3D,IAAI,CAAC;gBACH,iBAAE,CAAC,SAAS,CAAC,EAAE,CAAC,CAAA;YAClB,CAAC;YAAC,MAAM,CAAC;gBACP,mCAAmC;YACrC,CAAC;QACH,CAAC;QACD,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAA;IACtB,CAAC,CAAA;CACF;AAxCD,sCAwCC"}
@@ -0,0 +1,49 @@
1
+ /** Filesystem abstraction for opening lock files. */
2
+ export interface Fs<H extends FileHandle> {
3
+ /** Open (or create) the lock file and return a handle. */
4
+ open(file: string, type: Lock): Promise<H>;
5
+ }
6
+ /** Lock/unlock operations, separated from file opening for composability. */
7
+ export interface Locker {
8
+ /** Acquire a lock, polling until available or timeout is reached. */
9
+ lock: (fd: FileDescriptor, type: Lock, range?: LockRange, options?: PollOptions) => Promise<void>;
10
+ /** Try to acquire a lock without waiting. Return true if acquired. */
11
+ tryLock: (fd: FileDescriptor, type: Lock, range?: LockRange) => Promise<boolean>;
12
+ /** Release a previously acquired lock. */
13
+ unlock: (fd: FileDescriptor, range?: LockRange) => Promise<void>;
14
+ }
15
+ /** Lock mode: exclusive (write) or shared (read). */
16
+ export declare enum Lock {
17
+ Exclusive = 0,
18
+ Shared = 1
19
+ }
20
+ /** Options for polling lock acquisition. */
21
+ export interface PollOptions {
22
+ /** Polling interval in milliseconds. */
23
+ pollMs?: number;
24
+ /** Maximum wait time in milliseconds. */
25
+ timeout?: number;
26
+ /** Multiplier applied to pollMs after each failed attempt (e.g. 2 = exponential backoff). */
27
+ backoff?: number;
28
+ }
29
+ /** Byte range within a file to lock. Used for range-level locking. */
30
+ export interface LockRange {
31
+ /** Starting byte offset. */
32
+ offset: number;
33
+ /** Number of bytes to lock. */
34
+ length: number;
35
+ }
36
+ /** An open file handle with a descriptor and a close method. */
37
+ export interface FileHandle {
38
+ /** The numeric file descriptor. */
39
+ fd: number;
40
+ /** Close the file handle. */
41
+ close: () => Promise<void>;
42
+ }
43
+ /** File descriptor or file descriptor object. */
44
+ export type FileDescriptor = {
45
+ fd: number;
46
+ } | number;
47
+ /** @internal */
48
+ export declare const resolveFd: (fd: FileDescriptor) => number;
49
+ //# sourceMappingURL=types.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../lib/core/types.ts"],"names":[],"mappings":"AAAA,qDAAqD;AACrD,MAAM,WAAW,EAAE,CAAC,CAAC,SAAS,UAAU;IACtC,0DAA0D;IAC1D,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,GAAG,OAAO,CAAC,CAAC,CAAC,CAAA;CAC3C;AAED,6EAA6E;AAC7E,MAAM,WAAW,MAAM;IACrB,qEAAqE;IACrE,IAAI,EAAE,CAAC,EAAE,EAAE,cAAc,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,CAAC,EAAE,SAAS,EAAE,OAAO,CAAC,EAAE,WAAW,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;IACjG,sEAAsE;IACtE,OAAO,EAAE,CAAC,EAAE,EAAE,cAAc,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,CAAC,EAAE,SAAS,KAAK,OAAO,CAAC,OAAO,CAAC,CAAA;IAChF,0CAA0C;IAC1C,MAAM,EAAE,CAAC,EAAE,EAAE,cAAc,EAAE,KAAK,CAAC,EAAE,SAAS,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;CACjE;AAED,qDAAqD;AACrD,oBAAY,IAAI;IACd,SAAS,IAAA;IACT,MAAM,IAAA;CACP;AAED,4CAA4C;AAC5C,MAAM,WAAW,WAAW;IAC1B,wCAAwC;IACxC,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,yCAAyC;IACzC,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,6FAA6F;IAC7F,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB;AAED,sEAAsE;AACtE,MAAM,WAAW,SAAS;IACxB,4BAA4B;IAC5B,MAAM,EAAE,MAAM,CAAA;IACd,+BAA+B;IAC/B,MAAM,EAAE,MAAM,CAAA;CACf;AAED,gEAAgE;AAChE,MAAM,WAAW,UAAU;IACzB,mCAAmC;IACnC,EAAE,EAAE,MAAM,CAAA;IACV,6BAA6B;IAC7B,KAAK,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAA;CAC3B;AAED,iDAAiD;AACjD,MAAM,MAAM,cAAc,GAAG;IAAE,EAAE,EAAE,MAAM,CAAA;CAAE,GAAG,MAAM,CAAA;AAEpD,gBAAgB;AAChB,eAAO,MAAM,SAAS,GAAI,IAAI,cAAc,KAAG,MAA+C,CAAA"}
@@ -0,0 +1,13 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.resolveFd = exports.Lock = void 0;
4
+ /** Lock mode: exclusive (write) or shared (read). */
5
+ var Lock;
6
+ (function (Lock) {
7
+ Lock[Lock["Exclusive"] = 0] = "Exclusive";
8
+ Lock[Lock["Shared"] = 1] = "Shared";
9
+ })(Lock || (exports.Lock = Lock = {}));
10
+ /** @internal */
11
+ const resolveFd = (fd) => (typeof fd === 'number' ? fd : fd.fd);
12
+ exports.resolveFd = resolveFd;
13
+ //# sourceMappingURL=types.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"types.js","sourceRoot":"","sources":["../../../lib/core/types.ts"],"names":[],"mappings":";;;AAgBA,qDAAqD;AACrD,IAAY,IAGX;AAHD,WAAY,IAAI;IACd,yCAAS,CAAA;IACT,mCAAM,CAAA;AACR,CAAC,EAHW,IAAI,oBAAJ,IAAI,QAGf;AA+BD,gBAAgB;AACT,MAAM,SAAS,GAAG,CAAC,EAAkB,EAAU,EAAE,CAAC,CAAC,OAAO,EAAE,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAA;AAAjF,QAAA,SAAS,aAAwE"}
@@ -1,54 +1,63 @@
1
- import { type Backend, type FileHandle, type NodeFileHandle, FileGuard } from './backend/index.js';
2
- export * from './backend/index.js';
1
+ import { type NodeFileHandle, type LockRange, type PollOptions, type Lock, type FileHandle, type FileDescriptor, type Fs, type Locker, FileLockGuard, LockGuard } from './core/index.js';
2
+ export * from './core/index.js';
3
+ /** Options for specifying a custom locker and/or byte range. */
4
+ export interface LockingOptions {
5
+ /** Custom locker implementation. Uses the default native locker if omitted. */
6
+ locking?: Locker;
7
+ /** Byte range to lock. Locks the entire file if omitted. */
8
+ range?: LockRange;
9
+ }
3
10
  /**
4
- * Acquire an exclusive (write) lock on a file, polling until available.
5
- * Creates the file if it does not exist.
11
+ * Acquire a lock on an already-open file handle.
6
12
  *
7
13
  * @example
8
- * const guard = await exclusive('/tmp/my.lock')
9
- * try { /* critical section *\/ } finally { await guard.drop() }
14
+ * import fs from 'node:fs/promises'
15
+ * const handle = await fs.open('/tmp/my.lock', 'r+')
16
+ * await using guard = await lock(handle, Lock.Exclusive)
17
+ */
18
+ export declare const lock: <H extends FileHandle = NodeFileHandle>(handle: H, type: Lock, options?: LockingOptions & PollOptions) => Promise<LockGuard<H>>;
19
+ /**
20
+ * Try to acquire a lock on an already-open file handle without waiting.
10
21
  *
11
22
  * @example
12
- * await using guard = await exclusive('/tmp/my.lock', { timeout: 5000 })
23
+ * import fs from 'node:fs/promises'
24
+ * const handle = await fs.open('/tmp/my.lock', 'r+')
25
+ * const guard = await tryLock(handle, Lock.Exclusive)
26
+ * if (guard) { /* acquired *\/ }
13
27
  */
14
- export declare const exclusive: <H extends FileHandle = NodeFileHandle>(file: string, options?: {
15
- backend?: Backend<H>;
16
- pollMs?: number;
17
- timeout?: number;
18
- }) => Promise<FileGuard<H>>;
28
+ export declare const tryLock: <H extends FileDescriptor>(handle: H, type: Lock, options?: LockingOptions & PollOptions) => Promise<LockGuard<H> | undefined>;
19
29
  /**
20
- * Try to acquire an exclusive lock without waiting.
21
- * Return undefined if the lock is already held.
30
+ * Release a lock on a file descriptor or file handle.
22
31
  *
23
32
  * @example
24
- * const guard = await tryExclusive('/tmp/my.lock')
25
- * if (guard) { /* acquired *\/ }
33
+ * import fs from 'node:fs/promises'
34
+ * const handle = await fs.open('/tmp/my.lock', 'r+')
35
+ * await lock(handle, Lock.Exclusive)
36
+ * // ... critical section ...
37
+ * await unlock(handle)
26
38
  */
27
- export declare const tryExclusive: <H extends FileHandle = NodeFileHandle>(file: string, options?: {
28
- backend?: Backend<H>;
29
- }) => Promise<FileGuard<H> | undefined>;
39
+ export declare const unlock: <H extends FileDescriptor>(handle: H, options?: LockingOptions) => Promise<void>;
40
+ /** Options for open-and-lock functions that manage the file lifecycle. */
41
+ export interface OpenLockOptions<H extends FileHandle> extends LockingOptions {
42
+ /** Custom filesystem for opening files. Uses the default Node.js fs if omitted. */
43
+ fs?: Fs<H>;
44
+ }
30
45
  /**
31
- * Acquire a shared (read) lock on a file, polling until available.
32
- * Multiple shared locks may be held concurrently.
33
- * Creates the file if it does not exist.
46
+ * Open a file and acquire a lock, polling until available. Closes the file on failure.
47
+ *
48
+ * @example
49
+ * await using guard = await openLock('/tmp/my.lock', Lock.Exclusive)
34
50
  *
35
51
  * @example
36
- * await using guard = await shared('/tmp/my.lock')
52
+ * await using guard = await openLock('/tmp/my.lock', Lock.Shared, { timeout: 5000 })
37
53
  */
38
- export declare const shared: <H extends FileHandle = NodeFileHandle>(file: string, options?: {
39
- backend?: Backend<H>;
40
- pollMs?: number;
41
- timeout?: number;
42
- }) => Promise<FileGuard<H>>;
54
+ export declare const openLock: <H extends FileHandle = NodeFileHandle>(file: string, type: Lock, options?: OpenLockOptions<H> & PollOptions) => Promise<FileLockGuard<H>>;
43
55
  /**
44
- * Try to acquire a shared lock without waiting.
45
- * Return undefined if an exclusive lock is already held.
56
+ * Open a file and try to acquire a lock without waiting. Closes the file if not acquired.
46
57
  *
47
58
  * @example
48
- * const guard = await tryShared('/tmp/my.lock')
59
+ * const guard = await tryOpenLock('/tmp/my.lock', Lock.Exclusive)
49
60
  * if (guard) { /* acquired *\/ }
50
61
  */
51
- export declare const tryShared: <H extends FileHandle = NodeFileHandle>(file: string, options?: {
52
- backend?: Backend<H>;
53
- }) => Promise<FileGuard<H> | undefined>;
62
+ export declare const tryOpenLock: <H extends FileHandle = NodeFileHandle>(file: string, type: Lock, options?: OpenLockOptions<H>) => Promise<FileLockGuard<H> | undefined>;
54
63
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../lib/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,OAAO,EAAE,KAAK,UAAU,EAAE,KAAK,cAAc,EAAE,SAAS,EAAkB,MAAM,oBAAoB,CAAA;AAClH,cAAc,oBAAoB,CAAA;AAElC;;;;;;;;;;GAUG;AACH,eAAO,MAAM,SAAS,GAAU,CAAC,SAAS,UAAU,GAAG,cAAc,EACnE,MAAM,MAAM,EACZ,UAAU;IAAE,OAAO,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IAAC,OAAO,CAAC,EAAE,MAAM,CAAA;CAAE,KACpE,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAA4C,CAAA;AAEnE;;;;;;;GAOG;AACH,eAAO,MAAM,YAAY,GAAU,CAAC,SAAS,UAAU,GAAG,cAAc,EACtE,MAAM,MAAM,EACZ,UAAU;IAAE,OAAO,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,CAAA;CAAE,KACjC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,SAAS,CAA+C,CAAA;AAElF;;;;;;;GAOG;AACH,eAAO,MAAM,MAAM,GAAU,CAAC,SAAS,UAAU,GAAG,cAAc,EAChE,MAAM,MAAM,EACZ,UAAU;IAAE,OAAO,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IAAC,OAAO,CAAC,EAAE,MAAM,CAAA;CAAE,KACpE,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAyC,CAAA;AAEhE;;;;;;;GAOG;AACH,eAAO,MAAM,SAAS,GAAU,CAAC,SAAS,UAAU,GAAG,cAAc,EACnE,MAAM,MAAM,EACZ,UAAU;IAAE,OAAO,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,CAAA;CAAE,KACjC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,SAAS,CAA4C,CAAA"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../lib/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,cAAc,EACnB,KAAK,SAAS,EACd,KAAK,WAAW,EAChB,KAAK,IAAI,EACT,KAAK,UAAU,EACf,KAAK,cAAc,EACnB,KAAK,EAAE,EACP,KAAK,MAAM,EACX,aAAa,EACb,SAAS,EAGV,MAAM,iBAAiB,CAAA;AACxB,cAAc,iBAAiB,CAAA;AAE/B,gEAAgE;AAChE,MAAM,WAAW,cAAc;IAC7B,+EAA+E;IAC/E,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,4DAA4D;IAC5D,KAAK,CAAC,EAAE,SAAS,CAAA;CAClB;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,IAAI,GAAU,CAAC,SAAS,UAAU,GAAG,cAAc,EAC9D,QAAQ,CAAC,EACT,MAAM,IAAI,EACV,UAAU,cAAc,GAAG,WAAW,KACrC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAItB,CAAA;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,OAAO,GAAU,CAAC,SAAS,cAAc,EACpD,QAAQ,CAAC,EACT,MAAM,IAAI,EACV,UAAU,cAAc,GAAG,WAAW,KACrC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,SAAS,CAKlC,CAAA;AAED;;;;;;;;;GASG;AACH,eAAO,MAAM,MAAM,GAAU,CAAC,SAAS,cAAc,EAAE,QAAQ,CAAC,EAAE,UAAU,cAAc,KAAG,OAAO,CAAC,IAAI,CAGxG,CAAA;AAED,0EAA0E;AAC1E,MAAM,WAAW,eAAe,CAAC,CAAC,SAAS,UAAU,CAAE,SAAQ,cAAc;IAC3E,mFAAmF;IACnF,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAA;CACX;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,QAAQ,GAAU,CAAC,SAAS,UAAU,GAAG,cAAc,EAClE,MAAM,MAAM,EACZ,MAAM,IAAI,EACV,UAAU,eAAe,CAAC,CAAC,CAAC,GAAG,WAAW,KACzC,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAS1B,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,WAAW,GAAU,CAAC,SAAS,UAAU,GAAG,cAAc,EACrE,MAAM,MAAM,EACZ,MAAM,IAAI,EACV,UAAU,eAAe,CAAC,CAAC,CAAC,KAC3B,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,GAAG,SAAS,CAYtC,CAAA"}
package/dist/cjs/index.js CHANGED
@@ -14,71 +14,90 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
14
  for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
15
  };
16
16
  Object.defineProperty(exports, "__esModule", { value: true });
17
- exports.tryShared = exports.shared = exports.tryExclusive = exports.exclusive = void 0;
18
- const index_js_1 = require("./backend/index.js");
19
- __exportStar(require("./backend/index.js"), exports);
17
+ exports.tryOpenLock = exports.openLock = exports.unlock = exports.tryLock = exports.lock = void 0;
18
+ const index_js_1 = require("./core/index.js");
19
+ __exportStar(require("./core/index.js"), exports);
20
20
  /**
21
- * Acquire an exclusive (write) lock on a file, polling until available.
22
- * Creates the file if it does not exist.
21
+ * Acquire a lock on an already-open file handle.
23
22
  *
24
23
  * @example
25
- * const guard = await exclusive('/tmp/my.lock')
26
- * try { /* critical section *\/ } finally { await guard.drop() }
27
- *
28
- * @example
29
- * await using guard = await exclusive('/tmp/my.lock', { timeout: 5000 })
24
+ * import fs from 'node:fs/promises'
25
+ * const handle = await fs.open('/tmp/my.lock', 'r+')
26
+ * await using guard = await lock(handle, Lock.Exclusive)
30
27
  */
31
- const exclusive = async (file, options) => acquireLock(file, 'exclusive', options);
32
- exports.exclusive = exclusive;
28
+ const lock = async (handle, type, options) => {
29
+ const { locking = (0, index_js_1.defaultLocking)() } = options ?? {};
30
+ await locking.lock(handle, type, options?.range, options);
31
+ return new index_js_1.LockGuard(locking, handle, options?.range);
32
+ };
33
+ exports.lock = lock;
33
34
  /**
34
- * Try to acquire an exclusive lock without waiting.
35
- * Return undefined if the lock is already held.
35
+ * Try to acquire a lock on an already-open file handle without waiting.
36
36
  *
37
37
  * @example
38
- * const guard = await tryExclusive('/tmp/my.lock')
38
+ * import fs from 'node:fs/promises'
39
+ * const handle = await fs.open('/tmp/my.lock', 'r+')
40
+ * const guard = await tryLock(handle, Lock.Exclusive)
39
41
  * if (guard) { /* acquired *\/ }
40
42
  */
41
- const tryExclusive = async (file, options) => tryAcquireLock(file, 'exclusive', options);
42
- exports.tryExclusive = tryExclusive;
43
+ const tryLock = async (handle, type, options) => {
44
+ const { locking = (0, index_js_1.defaultLocking)() } = options ?? {};
45
+ const result = await locking.tryLock(handle, type, options?.range);
46
+ if (result)
47
+ return new index_js_1.LockGuard(locking, handle, options?.range);
48
+ return undefined;
49
+ };
50
+ exports.tryLock = tryLock;
43
51
  /**
44
- * Acquire a shared (read) lock on a file, polling until available.
45
- * Multiple shared locks may be held concurrently.
46
- * Creates the file if it does not exist.
52
+ * Release a lock on a file descriptor or file handle.
47
53
  *
48
54
  * @example
49
- * await using guard = await shared('/tmp/my.lock')
55
+ * import fs from 'node:fs/promises'
56
+ * const handle = await fs.open('/tmp/my.lock', 'r+')
57
+ * await lock(handle, Lock.Exclusive)
58
+ * // ... critical section ...
59
+ * await unlock(handle)
50
60
  */
51
- const shared = async (file, options) => acquireLock(file, 'shared', options);
52
- exports.shared = shared;
61
+ const unlock = async (handle, options) => {
62
+ const { locking = (0, index_js_1.defaultLocking)() } = options ?? {};
63
+ await locking.unlock(handle, options?.range);
64
+ };
65
+ exports.unlock = unlock;
53
66
  /**
54
- * Try to acquire a shared lock without waiting.
55
- * Return undefined if an exclusive lock is already held.
67
+ * Open a file and acquire a lock, polling until available. Closes the file on failure.
56
68
  *
57
69
  * @example
58
- * const guard = await tryShared('/tmp/my.lock')
59
- * if (guard) { /* acquired *\/ }
70
+ * await using guard = await openLock('/tmp/my.lock', Lock.Exclusive)
71
+ *
72
+ * @example
73
+ * await using guard = await openLock('/tmp/my.lock', Lock.Shared, { timeout: 5000 })
60
74
  */
61
- const tryShared = async (file, options) => tryAcquireLock(file, 'shared', options);
62
- exports.tryShared = tryShared;
63
- const acquireLock = async (file, mode, options) => {
64
- const { backend = (0, index_js_1.defaultBackend)() } = options ?? {};
65
- const handle = await backend.open(file);
75
+ const openLock = async (file, type, options) => {
76
+ const { fs = (0, index_js_1.defaultFs)() } = options ?? {};
77
+ const handle = await fs.open(file, type);
66
78
  try {
67
- await backend.lock(handle, mode, options);
68
- return new index_js_1.FileGuard(backend, handle);
79
+ return new index_js_1.FileLockGuard(await (0, exports.lock)(handle, type, options), handle);
69
80
  }
70
81
  catch (error) {
71
82
  await handle.close();
72
83
  throw error;
73
84
  }
74
85
  };
75
- const tryAcquireLock = async (file, mode, options) => {
76
- const { backend = (0, index_js_1.defaultBackend)() } = options ?? {};
77
- const handle = await backend.open(file);
86
+ exports.openLock = openLock;
87
+ /**
88
+ * Open a file and try to acquire a lock without waiting. Closes the file if not acquired.
89
+ *
90
+ * @example
91
+ * const guard = await tryOpenLock('/tmp/my.lock', Lock.Exclusive)
92
+ * if (guard) { /* acquired *\/ }
93
+ */
94
+ const tryOpenLock = async (file, type, options) => {
95
+ const { fs = (0, index_js_1.defaultFs)() } = options ?? {};
96
+ const handle = await fs.open(file, type);
78
97
  try {
79
- const result = await backend.tryLock(handle, mode);
98
+ const result = await (0, exports.tryLock)(handle, type, options);
80
99
  if (result)
81
- return new index_js_1.FileGuard(backend, handle);
100
+ return new index_js_1.FileLockGuard(result, handle);
82
101
  await handle.close();
83
102
  return undefined;
84
103
  }
@@ -87,4 +106,5 @@ const tryAcquireLock = async (file, mode, options) => {
87
106
  throw error;
88
107
  }
89
108
  };
109
+ exports.tryOpenLock = tryOpenLock;
90
110
  //# sourceMappingURL=index.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../lib/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,iDAAkH;AAClH,qDAAkC;AAElC;;;;;;;;;;GAUG;AACI,MAAM,SAAS,GAAG,KAAK,EAC5B,IAAY,EACZ,OAAqE,EAC9C,EAAE,CAAC,WAAW,CAAC,IAAI,EAAE,WAAW,EAAE,OAAO,CAAC,CAAA;AAHtD,QAAA,SAAS,aAG6C;AAEnE;;;;;;;GAOG;AACI,MAAM,YAAY,GAAG,KAAK,EAC/B,IAAY,EACZ,OAAkC,EACC,EAAE,CAAC,cAAc,CAAC,IAAI,EAAE,WAAW,EAAE,OAAO,CAAC,CAAA;AAHrE,QAAA,YAAY,gBAGyD;AAElF;;;;;;;GAOG;AACI,MAAM,MAAM,GAAG,KAAK,EACzB,IAAY,EACZ,OAAqE,EAC9C,EAAE,CAAC,WAAW,CAAC,IAAI,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAA;AAHnD,QAAA,MAAM,UAG6C;AAEhE;;;;;;;GAOG;AACI,MAAM,SAAS,GAAG,KAAK,EAC5B,IAAY,EACZ,OAAkC,EACC,EAAE,CAAC,cAAc,CAAC,IAAI,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAA;AAHlE,QAAA,SAAS,aAGyD;AAE/E,MAAM,WAAW,GAAG,KAAK,EACvB,IAAY,EACZ,IAA4B,EAC5B,OAAqE,EAC9C,EAAE;IACzB,MAAM,EAAE,OAAO,GAAG,IAAA,yBAAc,GAA2B,EAAE,GAAG,OAAO,IAAI,EAAE,CAAA;IAC7E,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IACvC,IAAI,CAAC;QACH,MAAM,OAAO,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,EAAE,OAAO,CAAC,CAAA;QACzC,OAAO,IAAI,oBAAS,CAAI,OAAO,EAAE,MAAM,CAAC,CAAA;IAC1C,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,MAAM,CAAC,KAAK,EAAE,CAAA;QACpB,MAAM,KAAK,CAAA;IACb,CAAC;AACH,CAAC,CAAA;AAED,MAAM,cAAc,GAAG,KAAK,EAC1B,IAAY,EACZ,IAA4B,EAC5B,OAAkC,EACC,EAAE;IACrC,MAAM,EAAE,OAAO,GAAG,IAAA,yBAAc,GAA2B,EAAE,GAAG,OAAO,IAAI,EAAE,CAAA;IAC7E,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IACvC,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,OAAO,CAAC,MAAM,EAAE,IAAI,CAAC,CAAA;QAClD,IAAI,MAAM;YAAE,OAAO,IAAI,oBAAS,CAAI,OAAO,EAAE,MAAM,CAAC,CAAA;QACpD,MAAM,MAAM,CAAC,KAAK,EAAE,CAAA;QACpB,OAAO,SAAS,CAAA;IAClB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,MAAM,CAAC,KAAK,EAAE,CAAA;QACpB,MAAM,KAAK,CAAA;IACb,CAAC;AACH,CAAC,CAAA"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../lib/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,8CAawB;AACxB,kDAA+B;AAU/B;;;;;;;GAOG;AACI,MAAM,IAAI,GAAG,KAAK,EACvB,MAAS,EACT,IAAU,EACV,OAAsC,EACf,EAAE;IACzB,MAAM,EAAE,OAAO,GAAG,IAAA,yBAAc,GAAE,EAAE,GAAG,OAAO,IAAI,EAAE,CAAA;IACpD,MAAM,OAAO,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,CAAC,CAAA;IACzD,OAAO,IAAI,oBAAS,CAAI,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,KAAK,CAAC,CAAA;AAC1D,CAAC,CAAA;AARY,QAAA,IAAI,QAQhB;AAED;;;;;;;;GAQG;AACI,MAAM,OAAO,GAAG,KAAK,EAC1B,MAAS,EACT,IAAU,EACV,OAAsC,EACH,EAAE;IACrC,MAAM,EAAE,OAAO,GAAG,IAAA,yBAAc,GAAE,EAAE,GAAG,OAAO,IAAI,EAAE,CAAA;IACpD,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,OAAO,CAAC,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,CAAC,CAAA;IAClE,IAAI,MAAM;QAAE,OAAO,IAAI,oBAAS,CAAI,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,KAAK,CAAC,CAAA;IACpE,OAAO,SAAS,CAAA;AAClB,CAAC,CAAA;AATY,QAAA,OAAO,WASnB;AAED;;;;;;;;;GASG;AACI,MAAM,MAAM,GAAG,KAAK,EAA4B,MAAS,EAAE,OAAwB,EAAiB,EAAE;IAC3G,MAAM,EAAE,OAAO,GAAG,IAAA,yBAAc,GAAE,EAAE,GAAG,OAAO,IAAI,EAAE,CAAA;IACpD,MAAM,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,EAAE,KAAK,CAAC,CAAA;AAC9C,CAAC,CAAA;AAHY,QAAA,MAAM,UAGlB;AAQD;;;;;;;;GAQG;AACI,MAAM,QAAQ,GAAG,KAAK,EAC3B,IAAY,EACZ,IAAU,EACV,OAA0C,EACf,EAAE;IAC7B,MAAM,EAAE,EAAE,GAAG,IAAA,oBAAS,GAAsB,EAAE,GAAG,OAAO,IAAI,EAAE,CAAA;IAC9D,MAAM,MAAM,GAAG,MAAM,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAA;IACxC,IAAI,CAAC;QACH,OAAO,IAAI,wBAAa,CAAI,MAAM,IAAA,YAAI,EAAC,MAAM,EAAE,IAAI,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,CAAA;IACxE,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,MAAM,CAAC,KAAK,EAAE,CAAA;QACpB,MAAM,KAAK,CAAA;IACb,CAAC;AACH,CAAC,CAAA;AAbY,QAAA,QAAQ,YAapB;AAED;;;;;;GAMG;AACI,MAAM,WAAW,GAAG,KAAK,EAC9B,IAAY,EACZ,IAAU,EACV,OAA4B,EACW,EAAE;IACzC,MAAM,EAAE,EAAE,GAAG,IAAA,oBAAS,GAAsB,EAAE,GAAG,OAAO,IAAI,EAAE,CAAA;IAC9D,MAAM,MAAM,GAAG,MAAM,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAA;IACxC,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,IAAA,eAAO,EAAC,MAAM,EAAE,IAAI,EAAE,OAAO,CAAC,CAAA;QACnD,IAAI,MAAM;YAAE,OAAO,IAAI,wBAAa,CAAI,MAAM,EAAE,MAAM,CAAC,CAAA;QACvD,MAAM,MAAM,CAAC,KAAK,EAAE,CAAA;QACpB,OAAO,SAAS,CAAA;IAClB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,MAAM,CAAC,KAAK,EAAE,CAAA;QACpB,MAAM,KAAK,CAAA;IACb,CAAC;AACH,CAAC,CAAA;AAhBY,QAAA,WAAW,eAgBvB"}
@@ -0,0 +1,50 @@
1
+ import { type FileDescriptor, type FileHandle, type Locker, type LockRange } from './types.js';
2
+ /**
3
+ * Guard that holds a lock without owning the file handle.
4
+ * Releasing the guard unlocks the file but does not close it.
5
+ *
6
+ * @example
7
+ * const guard = await lock(handle, Lock.Exclusive)
8
+ * try { /* work *\/ } finally { await guard.drop() }
9
+ */
10
+ export declare class LockGuard<H extends FileDescriptor> {
11
+ private locking;
12
+ private range?;
13
+ private _dropped;
14
+ /** The file descriptor number. */
15
+ readonly fd: number;
16
+ constructor(locking: Locker, handle: H, range?: LockRange | undefined);
17
+ /** True if the lock has been released. */
18
+ get dropped(): boolean;
19
+ /** Release the lock. Safe to call multiple times. */
20
+ drop(): Promise<void>;
21
+ [Symbol.asyncDispose](): Promise<void>;
22
+ }
23
+ /**
24
+ * RAII guard that holds a file lock. Unlocks and closes the file on drop.
25
+ * Supports `await using` via `Symbol.asyncDispose`.
26
+ *
27
+ * @example
28
+ * await using guard = await exclusive('/tmp/my.lock')
29
+ * // lock is released when guard goes out of scope
30
+ *
31
+ * @example
32
+ * const guard = await exclusive('/tmp/my.lock')
33
+ * try { /* work *\/ } finally { await guard.drop() }
34
+ */
35
+ export declare class FileLockGuard<H extends FileHandle> {
36
+ private guard;
37
+ private hndl;
38
+ private _dropped;
39
+ /** The file descriptor number. */
40
+ readonly fd: number;
41
+ constructor(guard: LockGuard<H>, hndl: H);
42
+ /** The underlying file handle. Throws if the guard has been dropped. */
43
+ get handle(): H;
44
+ /** True if the lock has been released. */
45
+ get dropped(): boolean;
46
+ /** Release the lock and close the file. Safe to call multiple times. */
47
+ drop(): Promise<void>;
48
+ [Symbol.asyncDispose](): Promise<void>;
49
+ }
50
+ //# sourceMappingURL=guard.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"guard.d.ts","sourceRoot":"","sources":["../../../lib/core/guard.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,cAAc,EAAE,KAAK,UAAU,EAAE,KAAK,MAAM,EAAE,KAAK,SAAS,EAAa,MAAM,YAAY,CAAA;AAEzG;;;;;;;GAOG;AACH,qBAAa,SAAS,CAAC,CAAC,SAAS,cAAc;IAM3C,OAAO,CAAC,OAAO;IAEf,OAAO,CAAC,KAAK,CAAC;IAPhB,OAAO,CAAC,QAAQ,CAA2B;IAC3C,kCAAkC;IAClC,SAAgB,EAAE,EAAE,MAAM,CAAA;gBAGhB,OAAO,EAAE,MAAM,EACvB,MAAM,EAAE,CAAC,EACD,KAAK,CAAC,EAAE,SAAS,YAAA;IAK3B,0CAA0C;IAC1C,IAAI,OAAO,YAEV;IAED,qDAAqD;IACrD,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAKrB,CAAC,MAAM,CAAC,YAAY,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC;CAGvC;AAED;;;;;;;;;;;GAWG;AACH,qBAAa,aAAa,CAAC,CAAC,SAAS,UAAU;IAM3C,OAAO,CAAC,KAAK;IACb,OAAO,CAAC,IAAI;IANd,OAAO,CAAC,QAAQ,CAA2B;IAC3C,kCAAkC;IAClC,SAAgB,EAAE,EAAE,MAAM,CAAA;gBAGhB,KAAK,EAAE,SAAS,CAAC,CAAC,CAAC,EACnB,IAAI,EAAE,CAAC;IAKjB,wEAAwE;IACxE,IAAI,MAAM,IAAI,CAAC,CAGd;IAED,0CAA0C;IAC1C,IAAI,OAAO,YAEV;IAED,wEAAwE;IACxE,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAarB,CAAC,MAAM,CAAC,YAAY,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC;CAGvC"}
@@ -1,3 +1,37 @@
1
+ import { resolveFd } from './types.js';
2
+ /**
3
+ * Guard that holds a lock without owning the file handle.
4
+ * Releasing the guard unlocks the file but does not close it.
5
+ *
6
+ * @example
7
+ * const guard = await lock(handle, Lock.Exclusive)
8
+ * try { /* work *\/ } finally { await guard.drop() }
9
+ */
10
+ export class LockGuard {
11
+ locking;
12
+ range;
13
+ _dropped;
14
+ /** The file descriptor number. */
15
+ fd;
16
+ constructor(locking, handle, range) {
17
+ this.locking = locking;
18
+ this.range = range;
19
+ this.fd = resolveFd(handle);
20
+ }
21
+ /** True if the lock has been released. */
22
+ get dropped() {
23
+ return !!this._dropped;
24
+ }
25
+ /** Release the lock. Safe to call multiple times. */
26
+ drop() {
27
+ if (!this._dropped)
28
+ this._dropped = this.locking.unlock(this.fd, this.range);
29
+ return this._dropped;
30
+ }
31
+ [Symbol.asyncDispose]() {
32
+ return this.drop();
33
+ }
34
+ }
1
35
  /**
2
36
  * RAII guard that holds a file lock. Unlocks and closes the file on drop.
3
37
  * Supports `await using` via `Symbol.asyncDispose`.
@@ -10,25 +44,22 @@
10
44
  * const guard = await exclusive('/tmp/my.lock')
11
45
  * try { /* work *\/ } finally { await guard.drop() }
12
46
  */
13
- export class FileGuard {
14
- backend;
47
+ export class FileLockGuard {
48
+ guard;
15
49
  hndl;
16
50
  _dropped;
17
- /** The lock file path. */
18
- path;
19
51
  /** The file descriptor number. */
20
52
  fd;
21
- constructor(backend, hndl) {
22
- this.backend = backend;
53
+ constructor(guard, hndl) {
54
+ this.guard = guard;
23
55
  this.hndl = hndl;
24
- this.path = hndl.path;
25
56
  this.fd = hndl.fd;
26
57
  }
27
58
  /** The underlying file handle. Throws if the guard has been dropped. */
28
59
  get handle() {
29
60
  if (this._dropped)
30
61
  throw new Error('FileGuard has been dropped');
31
- return this.hndl.handle;
62
+ return this.hndl;
32
63
  }
33
64
  /** True if the lock has been released. */
34
65
  get dropped() {
@@ -39,7 +70,7 @@ export class FileGuard {
39
70
  if (!this._dropped) {
40
71
  this._dropped = (async () => {
41
72
  try {
42
- await this.backend.unlock(this.hndl);
73
+ await this.guard.drop();
43
74
  }
44
75
  finally {
45
76
  await this.hndl.close();
@@ -0,0 +1 @@
1
+ {"version":3,"file":"guard.js","sourceRoot":"","sources":["../../../lib/core/guard.ts"],"names":[],"mappings":"AAAA,OAAO,EAAqE,SAAS,EAAE,MAAM,YAAY,CAAA;AAEzG;;;;;;;GAOG;AACH,MAAM,OAAO,SAAS;IAMV;IAEA;IAPF,QAAQ,CAA2B;IAC3C,kCAAkC;IAClB,EAAE,CAAQ;IAE1B,YACU,OAAe,EACvB,MAAS,EACD,KAAiB;QAFjB,YAAO,GAAP,OAAO,CAAQ;QAEf,UAAK,GAAL,KAAK,CAAY;QAEzB,IAAI,CAAC,EAAE,GAAG,SAAS,CAAC,MAAM,CAAC,CAAA;IAC7B,CAAC;IAED,0CAA0C;IAC1C,IAAI,OAAO;QACT,OAAO,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAA;IACxB,CAAC;IAED,qDAAqD;IACrD,IAAI;QACF,IAAI,CAAC,IAAI,CAAC,QAAQ;YAAE,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,KAAK,CAAC,CAAA;QAC5E,OAAO,IAAI,CAAC,QAAQ,CAAA;IACtB,CAAC;IAED,CAAC,MAAM,CAAC,YAAY,CAAC;QACnB,OAAO,IAAI,CAAC,IAAI,EAAE,CAAA;IACpB,CAAC;CACF;AAED;;;;;;;;;;;GAWG;AACH,MAAM,OAAO,aAAa;IAMd;IACA;IANF,QAAQ,CAA2B;IAC3C,kCAAkC;IAClB,EAAE,CAAQ;IAE1B,YACU,KAAmB,EACnB,IAAO;QADP,UAAK,GAAL,KAAK,CAAc;QACnB,SAAI,GAAJ,IAAI,CAAG;QAEf,IAAI,CAAC,EAAE,GAAG,IAAI,CAAC,EAAE,CAAA;IACnB,CAAC;IAED,wEAAwE;IACxE,IAAI,MAAM;QACR,IAAI,IAAI,CAAC,QAAQ;YAAE,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAA;QAChE,OAAO,IAAI,CAAC,IAAI,CAAA;IAClB,CAAC;IAED,0CAA0C;IAC1C,IAAI,OAAO;QACT,OAAO,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAA;IACxB,CAAC;IAED,wEAAwE;IACxE,IAAI;QACF,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;YACnB,IAAI,CAAC,QAAQ,GAAG,CAAC,KAAK,IAAI,EAAE;gBAC1B,IAAI,CAAC;oBACH,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,CAAA;gBACzB,CAAC;wBAAS,CAAC;oBACT,MAAM,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,CAAA;gBACzB,CAAC;YACH,CAAC,CAAC,EAAE,CAAA;QACN,CAAC;QACD,OAAO,IAAI,CAAC,QAAQ,CAAA;IACtB,CAAC;IAED,CAAC,MAAM,CAAC,YAAY,CAAC;QACnB,OAAO,IAAI,CAAC,IAAI,EAAE,CAAA;IACpB,CAAC;CACF"}
@@ -0,0 +1,8 @@
1
+ import { Locker, type Fs } from './types.js';
2
+ export { type Fs as Backend, type LockRange, type PollOptions, Lock, type FileDescriptor, type FileHandle, type Locker, type Fs, } from './types.js';
3
+ export * from './locking.js';
4
+ export * from './guard.js';
5
+ export * from './node.js';
6
+ export declare const defaultFs: () => Fs<import("node:fs/promises").FileHandle>;
7
+ export declare const defaultLocking: () => Locker;
8
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../lib/core/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,MAAM,YAAY,CAAA;AAG5C,OAAO,EACL,KAAK,EAAE,IAAI,OAAO,EAClB,KAAK,SAAS,EACd,KAAK,WAAW,EAChB,IAAI,EACJ,KAAK,cAAc,EACnB,KAAK,UAAU,EACf,KAAK,MAAM,EACX,KAAK,EAAE,GACR,MAAM,YAAY,CAAA;AACnB,cAAc,cAAc,CAAA;AAC5B,cAAc,YAAY,CAAA;AAC1B,cAAc,WAAW,CAAA;AAIzB,eAAO,MAAM,SAAS,iDAGrB,CAAA;AAID,eAAO,MAAM,cAAc,cAG1B,CAAA"}
@@ -0,0 +1,21 @@
1
+ import { createNodeFs, NodeLockHooks } from './node.js';
2
+ import { createLocker } from './locking.js';
3
+ export { Lock, } from './types.js';
4
+ export * from './locking.js';
5
+ export * from './guard.js';
6
+ export * from './node.js';
7
+ /** Lazily create and return the shared default Node.js filesystem singleton. */
8
+ let _defaultFs;
9
+ export const defaultFs = () => {
10
+ if (!_defaultFs)
11
+ _defaultFs = createNodeFs();
12
+ return _defaultFs;
13
+ };
14
+ /** Lazily create and return the shared default native locker singleton. */
15
+ let _defaultLocking;
16
+ export const defaultLocking = () => {
17
+ if (!_defaultLocking)
18
+ _defaultLocking = createLocker(new NodeLockHooks());
19
+ return _defaultLocking;
20
+ };
21
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../lib/core/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,aAAa,EAAuB,MAAM,WAAW,CAAA;AAE5E,OAAO,EAAE,YAAY,EAAE,MAAM,cAAc,CAAA;AAE3C,OAAO,EAIL,IAAI,GAKL,MAAM,YAAY,CAAA;AACnB,cAAc,cAAc,CAAA;AAC5B,cAAc,YAAY,CAAA;AAC1B,cAAc,WAAW,CAAA;AAEzB,gFAAgF;AAChF,IAAI,UAA0C,CAAA;AAC9C,MAAM,CAAC,MAAM,SAAS,GAAG,GAAG,EAAE;IAC5B,IAAI,CAAC,UAAU;QAAE,UAAU,GAAG,YAAY,EAAE,CAAA;IAC5C,OAAO,UAAU,CAAA;AACnB,CAAC,CAAA;AAED,2EAA2E;AAC3E,IAAI,eAAmC,CAAA;AACvC,MAAM,CAAC,MAAM,cAAc,GAAG,GAAG,EAAE;IACjC,IAAI,CAAC,eAAe;QAAE,eAAe,GAAG,YAAY,CAAC,IAAI,aAAa,EAAE,CAAC,CAAA;IACzE,OAAO,eAAe,CAAA;AACxB,CAAC,CAAA"}