version 1.0.0

Author: stagas

README.md

@@ -1,7 +1,7 @@
 <h1 align="center">atomic</h1>
 
 <p align="center">
-Atomic operations
+makes a function atomic with timeout and abort signal
 </p>
 
 <p align="center">
@@ -13,7 +13,7 @@ Atomic operations
  · <a href="https://github.com/stagas/atomic/issues">   🖐️ <strong>Help</strong></a>
 </p>
 
----
+***
 
 ## Install
 
@@ -23,16 +23,52 @@ $ npm i atomic
 
 ## API
 
-wip
+<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
+
+#### Table of Contents
+
+*   [atomic](#atomic)
+    *   [Parameters](#parameters)
+
+### atomic
+
+[src/index.ts:33-78](https://github.com/stagas/atomic/blob/2a0a9f5694e915eb4fe86dea4895ed398d1458c3/src/index.ts#L33-L78 "Source code on GitHub")
+
+Makes a function atomic.
+
+```js
+const fn = atomic(signal => async () => {
+  // some long async operation
+
+  // if we've been aborted during the long
+  // async process above, we wouldn't want
+  // to continue so lets return here
+  if (signal.aborted) return
+
+  // do things here if we didn't abort
+}, 500) // timeout at 500ms (don't pass anything for no timeout)
+fn()
+fn()
+fn()
+await fn() // this will run after the above have settled
+```
+
+#### Parameters
+
+*   `signalClosure` **function (signal: AbortSignal): function (...args: [Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)\<any>): [Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<any>** A function that receives the signal object
+    from an AbortController and returns the function to become atomic.
+*   `maxTimeMs` **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)?** Time in milliseconds to timeout the operation. Will also signal abort.
+
+Returns **any** An atomic function
 
 ## Contribute
 
-[Fork](https://github.com/stagas/atomic/fork) or 
+[Fork](https://github.com/stagas/atomic/fork) or
 [edit](https://github.dev/stagas/atomic) and submit a PR.
 
 All contributions are welcome!
 
 ## License
 
-MIT &copy; 2022
+MIT © 2022
 [stagas](https://github.com/stagas)

package.json

@@ -3,13 +3,21 @@
   "author": "stagas",
   "short": "stagas/atomic",
   "description": "makes a function atomic with timeout and abort signal",
-  "version": "0.0.0",
+  "version": "1.0.0",
   "license": "MIT",
   "repository": {
     "type": "git",
     "url": "git+https://[email protected]:stagas/atomic.git"
   },
-  "keywords": [],
+  "keywords": [
+    "atomic",
+    "promise",
+    "concurrency",
+    "timeout",
+    "signal",
+    "abort",
+    "race-conditions"
+  ],
   "module": "dist/esm/index.js",
   "main": "dist/cjs/index.js",
   "exports": {