aa - npm Package Compare versions

Comparing version 0.1.27 to 0.1.28

package.json

 {
   "name": "aa",
-  "version": "0.1.27",
+  "version": "0.1.28",
   "description": "aa - async-await. co like library, go like channel, thunkify or promisify wrap package.",
   "main": "aa.js",
   "dependencies": {
-    "promise-thunk": ">=0.1.8"
+    "promise-thunk": ">=0.1.9"
   },
@@ -9,0 +9,0 @@ "devDependencies": {

README.md

 [aa](https://www.npmjs.com/package/aa) - [async-await](https://www.npmjs.com/package/async-await)
 ====
 
-[aa](https://www.npmjs.com/package/aa) - [async-await](https://www.npmjs.com/package/async-await)
-====
-
-  [aa](https://www.npmjs.com/package/aa) - [async-await](https://www.npmjs.com/package/async-await) library. <br>
   co like library, go like channel, thunkify or promisify wrap package.
@@ -37,2 +33,6 @@
   var aa = require('async-await');
+
+  var thunkify  = aa.thunkify;
+  var promisify = aa.promisify;
+  var Channel   = aa.Channel;
 ```
@@ -44,7 +44,9 @@
 
-### aa(generator or generator function) : returns promise (thunkified promise)
+### aa(generator or generator function) 
 
-basic usage. <br>
-you can `aa()` promises, generators, and generator functions.
+  `aa()` returns promise (thunkified promise).
 
+  basic usage. <br>
+  you can `aa()` promises, generators, and generator functions.
+
 ```js
@@ -83,12 +85,76 @@ aa(function *() {
 
-### aa.promisify(node style function) : function returns promise
+### aa.promisify([ctx,] fn, [options])
 
-`promisify()` converts node style function into a function returns promise. <br>
-you can use `fs.exists()` and `child_process.exec()` also.
+  `promisify()` converts node style function into a function returns promise-thunk. <br>
+  you can use `fs.exists()` and `child_process.exec()` also.
 
-### aa.thunkify(node style function) : function returns thunk
+  + `ctx`: context object. default: this or undefined.
+  + `fn`: node-style normal function.
+  + `options`: options object.
+    + `conbtext`: context object.
 
-`thunkify()` converts node style function into a thunkified function. <br>
-you can use `fs.exists()` and `child_process.exec()` also.
+  also thenable, yieldable, callable.
 
+#### postgres `pg` example:
+
+```js
+var pg = require('pg');
+var pg_connect = promisify(pg, pg.connect);         // -> yield pg_connect()
+var client_query = promisify(client, client.query); // -> yield client_query()
+```
+
+### aa.promisify(object, method, [postfix])
+
+  `promisify()` defines method promisified function returns promise-thunk.
+
+  + `object`: target object.
+  + `method`: method name string.
+  + `postfix`: method name postfix or suffix. default: 'A'.
+
+#### postgres `pg` example:
+
+```js
+var pg = require('pg');
+promisify(pg, 'connect');                  // -> yield pg.connectA()
+promisify(pg.Client.prototype, 'connect'); // -> yield client.connectA()
+promisify(pg.Client.prototype, 'query');   // -> yield client.queryA()
+```
+
+### aa.thunkify([ctx,] fn, [options])
+
+  `thunkify()` converts node style function into a thunkified function. <br>
+  you can use `fs.exists()` and `child_process.exec()` also.
+
+  + `ctx`: context object. default: this or undefined.
+  + `fn`: node-style normal function with callback.
+  + `options`: options object.
+    + `conbtext`: context object.
+
+  also yieldable, callable.
+
+#### postgres `pg` example:
+
+```js
+var pg = require('pg');
+var pg_connect = thunkify(pg, pg.connect);         // -> yield pg_connect()
+var client_query = thunkify(client, client.query); // -> yield client_query()
+```
+
+### aa.thunkify(object, method, [postfix])
+
+  `thunkify()` defines method thunkified function returns thunk.
+
+  + `object`: target object.
+  + `method`: method name string.
+  + `postfix`: method name postfix or suffix. default: 'A'.
+
+#### postgres `pg` example:
+
+```js
+var pg = require('pg');
+thunkify(pg, 'connect');                  // -> yield pg.connectA()
+thunkify(pg.Client.prototype, 'connect'); // -> yield client.connectA()
+thunkify(pg.Client.prototype, 'query');   // -> yield client.queryA()
+```
+
 ### aa.Channel() : new channel for event stream
@@ -95,0 +161,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

24736

increased by7.79%

Number of lines in readme file

564

increased by13.25%

Dependency changes

• Updatedpromise-thunk@>=0.1.9