p-event - npm Package Compare versions

Comparing version 1.0.0 to 1.1.0

index.js

@@ -7,3 +7,4 @@ 'use strict';
 		opts = Object.assign({
-			rejectionEvents: ['error']
+			rejectionEvents: ['error'],
+			multiArgs: false
 		}, opts);
@@ -21,10 +22,20 @@
 
-		const resolveHandler = value => {
+		const resolveHandler = function (value) {
 			cancel();
-			resolve(value);
+
+			if (opts.multiArgs) {
+				resolve([].slice.apply(arguments));
+			} else {
+				resolve(value);
+			}
 		};
 
-		const rejectHandler = reason => {
+		const rejectHandler = function (reason) {
 			cancel();
-			reject(reason);
+
+			if (opts.multiArgs) {
+				reject([].slice.apply(arguments));
+			} else {
+				reject(reason);
+			}
 		};
@@ -31,0 +42,0 @@

package.json

 {
   "name": "p-event",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "Promisify an event by waiting for it to be emitted",
@@ -5,0 +5,0 @@ "license": "MIT",

readme.md

@@ -76,3 +76,23 @@ # p-event [![Build Status](https://travis-ci.org/sindresorhus/p-event.svg?branch=master)](https://travis-ci.org/sindresorhus/p-event)
 
+##### multiArgs
 
+Type: `boolean`<br>
+Default: `false`
+
+By default, the promisified function will only return the first argument from the callback, which works fine for most APIs. This option can be useful for modules like `kue` that return multiple arguments. Turning this on will make it return an array of all arguments from the callback, instead of just the first argument. This also applies to rejections.
+
+Example:
+
+```js
+const kue = require('kue');
+const pEvent = require('p-event');
+
+const queue = kue.createQueue();
+
+pEvent(queue, 'job enqueue', {multiArgs: true}).then(result => {
+	const [id, type] = result;
+});
+```
+
+
 ## Before and after
@@ -79,0 +99,0 @@

No alert changes

Improved metrics

Total package byte prevSize

6745

increased by14.05%

Lines of code

45

increased by25%

Number of lines in readme file

154

increased by14.93%

No dependency changes