apr-asyncify - npm Package Compare versions

Comparing version 1.0.1 to 1.0.2

readme.md

+<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
+
+## asyncify
+
+<a id="asyncify"></a>
+Take a sync function and make it async. This is useful for plugging sync functions into a [`waterfall`](#waterfall), [`series`](#series), or other async functions.
+
+[![](https://img.shields.io/npm/v/apr-asyncify.svg?style=flat-square)](https://www.npmjs.com/package/apr-asyncify) [![](https://img.shields.io/npm/l/apr-asyncify.svg?style=flat-square)](https://www.npmjs.com/package/apr-asyncify)
+
+**Parameters**
+
+-   `function` **[Function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/function)** 
+
+**Examples**
+
+```javascript
+import awaitify from 'apr-awaitify';
+import asyncify from 'apr-asyncify';
+import waterfall from 'apr-waterfall';
+import apply from 'apr-apply';
+
+const readFile = awaitify(require('fs').readFile);
+const pkgPath = path.join(__dirname, './package.json');
+
+const pkg = await waterfall([
+  apply(readFile, pkgPath, 'utf8'),
+  asyncify(JSON.parse)
+]);
+```
+
+Returns **[Function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/function)** 

index.js

@@ -0,1 +1,26 @@
+/**
+ * <a id="asyncify"></a>
+ * Take a sync function and make it async. This is useful for plugging sync functions into a [`waterfall`](#waterfall), [`series`](#series), or other async functions.
+ *
+ * [![](https://img.shields.io/npm/v/apr-asyncify.svg?style=flat-square)](https://www.npmjs.com/package/apr-asyncify) [![](https://img.shields.io/npm/l/apr-asyncify.svg?style=flat-square)](https://www.npmjs.com/package/apr-asyncify)
+ *
+ * @kind function
+ * @name asyncify
+ * @param {Function} function
+ * @returns {Function}
+ *
+ * @example
+ * import awaitify from 'apr-awaitify';
+ * import asyncify from 'apr-asyncify';
+ * import waterfall from 'apr-waterfall';
+ * import apply from 'apr-apply';
+ * 
+ * const readFile = awaitify(require('fs').readFile);
+ * const pkgPath = path.join(__dirname, './package.json');
+ * 
+ * const pkg = await waterfall([
+ *   apply(readFile, pkgPath, 'utf8'),
+ *   asyncify(JSON.parse)
+ * ]);
+ */
 module.exports = (fn) => {
@@ -2,0 +27,0 @@ return (...args) => {

package.json

 {
   "name": "apr-asyncify",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "homepage": "https://github.com/ramitos/apr/tree/master/packages/asyncify",
@@ -5,0 +5,0 @@ "license": "MIT",

New alerts

Filesystem access

Supply chain risk

Accesses the file system, and could potentially read sensitive data.

Found 1 instance in 1 package

Fixed alerts

No README

Quality

Package does not have a README. This may indicate a failed publish or a low quality package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

2586

408.06%

Number of package files

3

50%

Lines of code

36

227.27%

Number of medium quality alerts

1

-50%

Number of lines in readme file

32

Infinity%

Worsened metrics

Number of low supply chain risk alerts

2

100%

No dependency changes