aveazul 0.1.2 → 0.1.3

package/README.md

@@ -1,18 +1,6 @@
 # AveAzul
 
-AveAzul ("Blue Bird" in Spanish) is a Promise extension library that provides Bluebird-like utility methods built on top of native Promises. The name is a Spanish play on words referencing Bluebird.
-
-## Requirements
-
-- Node.js 16 or higher
-
-## Features
-
-- Extends native Promise with Bluebird-like utility methods
-- Built on top of the efficient `xaa` library for async operations
-- Zero external runtime dependencies (other than `xaa`)
-- TypeScript-friendly
-- Familiar Bluebird-style API
+AveAzul ("Blue Bird" in Spanish) is a Promise library that extends native Promises with Bluebird-like utility methods. Built on top of native Promises, it provides a familiar API for Node.js developers who are used to working with [Bluebird](https://github.com/petkaantonov/bluebird) ([npm](https://www.npmjs.com/package/bluebird)).
 
 ## Installation
 
@@ -25,63 +13,88 @@ npm install aveazul
 ```javascript
 const AveAzul = require('aveazul');
 
-// Create a new promise
-const promise = new AveAzul((resolve, reject) => {
-  setTimeout(() => resolve('result'), 1000);
-});
+// Basic Promise usage
+const promise = new AveAzul((resolve) => resolve(42));
+promise.then(value => console.log(value)); // 42
 
-// Use Bluebird-style methods
-promise
-  .tap(value => console.log('Got:', value))
-  .delay(500)
-  .then(value => console.log('After delay:', value));
-
-// Static helpers
-AveAzul.delay(1000, 'hello')
-  .then(value => console.log(value));
-
-// Array operations
+// Utility methods
 AveAzul.resolve([1, 2, 3])
   .map(x => x * 2)
-  .filter(x => x > 4)
-  .then(result => console.log(result)); // [6]
+  .filter(x => x > 2)
+  .then(result => console.log(result)); // [4, 6]
+
+// Promisify callback-style functions
+const fs = require('fs');
+const readFile = AveAzul.promisify(fs.readFile);
+readFile('file.txt').then(content => console.log(content));
+
+// Promisify all methods of an object
+const obj = {
+  method(cb) { cb(null, 'result'); }
+};
+AveAzul.promisifyAll(obj);
+obj.methodAsync().then(result => console.log(result)); // 'result'
 ```
 
 ## API
 
 ### Instance Methods
 
-- `tap(fn)` - Execute side effects in a chain
+- `tap(fn)` - Execute side effects and return original value
 - `filter(fn)` - Filter array elements
-- `map(fn)` - Map array elements
-- `return(value)` - Inject a value into the chain
+- `map(fn)` - Transform array elements
+- `return(value)` - Inject a new value
 - `each(fn)` - Iterate over array elements
-- `delay(ms)` - Delay execution
-- `timeout(ms, message?)` - Set operation timeout
+- `delay(ms)` - Delay resolution
+- `timeout(ms, message?)` - Reject after specified time
 - `try(fn)` - Wrap sync/async functions
-- `props(obj)` - Handle object properties
-- `reduce(fn, initialValue?)` - Reduce array
+- `props(obj)` - Resolve object properties
+- `catchIf(predicate, fn)` - Catch specific errors
+- `tapCatch(fn)` - Execute side effects on rejection
+- `reduce(fn, initialValue?)` - Reduce array elements
 - `throw(reason)` - Return rejected promise
 - `catchThrow(reason)` - Catch and throw new error
 - `catchReturn(value)` - Catch and return value
-- `get(propertyPath)` - Get nested property
+- `get(propertyPath)` - Retrieve property value
 
 ### Static Methods
 
-- `AveAzul.delay(ms, value?)` - Create delayed promise
-- `AveAzul.map(array, fn)` - Map array elements
-- `AveAzul.try(fn)` - Wrap function execution
-- `AveAzul.props(obj)` - Handle object properties
-- `AveAzul.defer()` - Create deferred promise
-- `AveAzul.promisify(fn, options?)` - Promisify callback functions
-- `AveAzul.each(items, fn)` - Iterate over items
-- `AveAzul.reduce(array, fn, initialValue?)` - Reduce array
-- `AveAzul.throw(reason)` - Create rejected promise
+- `delay(ms, value?)` - Resolve after specified time
+- `map(value, fn)` - Transform array elements
+- `try(fn)` - Wrap sync/async functions
+- `props(obj)` - Resolve object properties
+- `defer()` - Create a deferred promise
+- `promisify(fn, options?)` - Convert callback-style functions to promises
+- `each(items, fn)` - Iterate over array elements
+- `reduce(array, fn, initialValue?)` - Reduce array elements
+- `throw(reason)` - Return rejected promise
+- `promisifyAll(target, options?)` - Convert all methods of an object/class to promises
+
+### PromisifyAll Options
+
+- `suffix` (default: 'Async') - Suffix to append to promisified method names
+- `filter` - Filter function to determine which methods to promisify
+- `promisifier` - Custom function to handle promisification
+- `multiArgs` (default: false) - Whether to support multiple callback arguments
+- `excludeMain` (default: false) - Whether to exclude promisifying the main object/class
+- `context` - The context (this) to use when calling methods
+
+## Development
+
+```bash
+# Install dependencies
+npm install
+
+# Run tests
+npm test
+npm run test:watch
+npm run test:coverage
+```
 
 ## License
 
-Apache 2.0
+Apache-2.0
 
-## Dependencies
+## Author
 
-- [xaa](https://github.com/jchip/xaa) - Efficient async/await helpers
+Joel Chen

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "aveazul",
-  "version": "0.1.2",
-  "description": "Extend native Promise with bluebird like APIs for Node.js",
+  "version": "0.1.3",
+  "description": "Bluebird-like APIs in extended native Promise",
   "main": "lib/aveazul.js",
   "homepage": "https://github.com/jchip/aveazul",
   "license": "Apache-2.0",