superlock 1.0.0 → 1.0.2

package/README.md

@@ -32,40 +32,21 @@ const delay = require('delay')
 
 const lock = withLock()
 
-const promiseOne = lock.then(() => {
-  console.log('mutual exclusion is guaranteed')
-  return delay(50)
-})
-
-const promiseTwo = lock.then(() => {
-  console.log('do something')
-  return delay(100)
-})
+const executions = await Promise.all(
+  [...Array(10).keys()].map(index =>
+    lock(async () => {
+      await delay(Math.random() * 100)
+      return index
+    })
+  )
+)
 
-Promise.all([promiseOne, promiseTwo])
+console.log(executions)
 ```
 
 ### as semaphore
 
-Just pass the desired concurrency as first argument:
-
-```js
-const { withLock } = require('superlock')
-const delay = require('delay')
-
-const lock = withLock(2)
-
-const executions = []
-
-Promise.all(
-  [...Array(100).keys()].map(async index => {
-    await delay(Math.random() * 100)
-    return index
-  })
-)
-
-console.log(executions)
-```
+Just call `withLock(n)` being `n` the maximum of concurrency desired for the lock.
 
 ## API
 
@@ -78,7 +59,7 @@ const { withLock } = require('superlock')
 
 const lock = createLock()
 
-lock().then(() => {
+await lock(() => {
   /* your code execution */
 })
 ```
@@ -96,7 +77,7 @@ It sets the maximum of concurrency allowed for the lock.
 
 Type: `boolean`
 
-It indicates if there is at least one free concurrency slots in the lock.
+It returns `false` if there is at least one free concurrency slots in the lock.
 
 ## License
 

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "superlock",
   "description": "The most simple mutex/semaphore implementation",
-  "homepage": "https://nicedoc.io/Kikobeats/lock",
-  "version": "1.0.0",
+  "homepage": "https://github.com/Kikobeats/superlock",
+  "version": "1.0.2",
   "main": "src/index.js",
   "author": {
     "email": "josefrancisco.verdu@gmail.com",
@@ -11,10 +11,10 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/Kikobeats/lock.git"
+    "url": "git+https://github.com/Kikobeats/superlock.git"
   },
   "bugs": {
-    "url": "https://github.com/Kikobeats/lock/issues"
+    "url": "https://github.com/Kikobeats/superlock/issues"
   },
   "keywords": [
     "async",
@@ -40,7 +40,6 @@
     "prettier-standard": "latest",
     "simple-git-hooks": "latest",
     "standard": "latest",
-    "standard-markdown": "latest",
     "standard-version": "latest"
   },
   "engines": {
@@ -49,6 +48,21 @@
   "files": [
     "src"
   ],
+  "scripts": {
+    "clean": "rm -rf node_modules",
+    "contributors": "(npx git-authors-cli && npx finepack --sort-ignore-object-at ava && git add package.json && git commit -m 'build: contributors' --no-verify) || true",
+    "coverage": "c8 report --reporter=text-lcov > coverage/lcov.info",
+    "lint": "standard",
+    "postrelease": "npm run release:tags && npm run release:github && (ci-publish || npm publish --access=public)",
+    "prerelease": "npm run update:check && npm run contributors",
+    "pretest": "npm run lint",
+    "release": "standard-version -a",
+    "release:github": "conventional-github-releaser -p angular",
+    "release:tags": "git push --follow-tags origin HEAD:master",
+    "test": "c8 ava",
+    "update": "ncu -u",
+    "update:check": "ncu -- --error-level 2"
+  },
   "license": "MIT",
   "ava": {
     "files": [
@@ -69,9 +83,6 @@
     "*.js,!*.min.js,": [
       "prettier-standard"
     ],
-    "*.md": [
-      "standard-markdown"
-    ],
     "package.json": [
       "finepack --sort-ignore-object-at ava"
     ]
@@ -79,20 +90,5 @@
   "simple-git-hooks": {
     "commit-msg": "npx commitlint --edit",
     "pre-commit": "npx nano-staged"
-  },
-  "scripts": {
-    "clean": "rm -rf node_modules",
-    "contributors": "(git-authors-cli && finepack --sort-ignore-object-at ava && git add package.json && git commit -m 'build: contributors' --no-verify) || true",
-    "coverage": "c8 report --reporter=text-lcov > coverage/lcov.info",
-    "lint": "standard-markdown README.md && standard",
-    "postrelease": "npm run release:tags && npm run release:github && (ci-publish || npm publish --access=public)",
-    "prerelease": "npm run update:check && npm run contributors",
-    "pretest": "npm run lint",
-    "release": "standard-version -a",
-    "release:github": "conventional-github-releaser -p angular",
-    "release:tags": "git push --follow-tags origin HEAD:master",
-    "test": "c8 ava",
-    "update": "ncu -u",
-    "update:check": "ncu -- --error-level 2"
   }
-}
+}

package/src/create.js

@@ -8,16 +8,17 @@ module.exports = (slots = 1) => {
     if (queue.length > 0) queue.shift()()
   }
 
-  const acquire = resolve => () => {
+  const acquire = resolve => {
     --slots
     resolve(release)
   }
 
   const lock = () =>
-    new Promise(resolve => {
-      const fn = acquire(resolve)
-      lock.isLocked() ? queue.push(fn) : fn()
-    })
+    new Promise(resolve =>
+      lock.isLocked()
+        ? queue.push(acquire.bind(null, resolve))
+        : acquire(resolve)
+    )
 
   lock.isLocked = () => slots === 0