superlock 1.0.7 → 1.1.0

package/README.md

@@ -27,15 +27,15 @@ $ npm install superlock --save
 The lock is a mutex by default:
 
 ```js
+const { setTimeout } = require('timers/promises')
 const { withLock } = require('superlock')
-const delay = require('delay')
 
 const lock = withLock()
 
 const executions = await Promise.all(
   [...Array(10).keys()].map(index =>
     lock(async () => {
-      await delay(Math.random() * 100)
+      await setTimeout(Math.random() * 100)
       return index
     })
   )
@@ -57,7 +57,7 @@ It returns a function that can be used to wrap any code you want to execute with
 ```js
 const { withLock } = require('superlock')
 
-const lock = createLock()
+const lock = withLock()
 
 await lock(() => {
   /* your code execution */

package/package.json

@@ -2,7 +2,8 @@
   "name": "superlock",
   "description": "The most simple mutex/semaphore implementation",
   "homepage": "https://github.com/Kikobeats/superlock",
-  "version": "1.0.7",
+  "version": "1.1.0",
+  "types": "src/index.d.ts",
   "main": "src/index.js",
   "exports": {
     ".": "./src/index.js",

package/src/index.d.ts

@@ -0,0 +1,19 @@
+declare type Release = () => void;
+declare type Acquire = (resolve: (release: Release) => void) => void;
+declare type Lock = () => Promise<Release>;
+
+interface LockInterface extends Lock {
+  isLocked: () => boolean;
+}
+
+declare function createLock(slots?: number): LockInterface;
+
+declare type WithLock = <T>(fn: () => Promise<T>) => Promise<T>;
+
+interface WithLockInterface extends WithLock {
+  isLocked: () => boolean;
+}
+
+declare function withLock(opts: number): WithLockInterface;
+
+export { withLock, createLock };