util.promisify - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

CHANGELOG.md

@@ -1,3 +0,58 @@
-1.0.0 / 2017-05-30
-=================
-  * Initial release.
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
+
+## [v1.0.1](https://github.com/ljharb/util.promisify/compare/v1.0.0...v1.0.1) - 2020-01-16
+
+### Fixed
+
+- [Refactor] remove unnecessary duplication. Fixes #3. [`#3`](https://github.com/ljharb/util.promisify/issues/3)
+
+### Commits
+
+- [Tests] use shared travis-ci configs [`f1b5e43`](https://github.com/ljharb/util.promisify/commit/f1b5e43359e74a30f35bd10a33be765de73917c6)
+- [Tests] up to `node` `v10.0`, `v9.11`, `v8.11`, `v6.14`, `4.9`; use `nvm install-latest-npm`; pin included builds to LTS [`e89390f`](https://github.com/ljharb/util.promisify/commit/e89390f498f7eb5111188fff5260cbb9f5216cd3)
+- [meta] add `auto-changelog` [`fe8e751`](https://github.com/ljharb/util.promisify/commit/fe8e751819a1318d3c929b086c70308aed50715d)
+- [Tests] up to `node` `v11.0`, `v10.12`, `v8.12` [`e09b894`](https://github.com/ljharb/util.promisify/commit/e09b894291aef2991e5c553f0b64968e03b58262)
+- [Refactor] use `callBound` helper from `es-abstract` for robustness [`baa0cf6`](https://github.com/ljharb/util.promisify/commit/baa0cf697068573cbe650e01aa6774154dd3f454)
+- [actions] add automatic rebasing / merge commit blocking [`24912f4`](https://github.com/ljharb/util.promisify/commit/24912f41b30d88b8984fb07307f737de6f576873)
+- [Docs] Add usage information for the shim/monkey-patch [`38b1ee5`](https://github.com/ljharb/util.promisify/commit/38b1ee56b558019213a6fdc2553796e8cdaf773e)
+- [Refactor] use `__proto__` instead of ES6’s `Object.setPrototypeOf` [`02ec7e2`](https://github.com/ljharb/util.promisify/commit/02ec7e241caf8848c1e141c801f98ed31325b59a)
+- [meta] create FUNDING.yml [`076b8b5`](https://github.com/ljharb/util.promisify/commit/076b8b5d19783a0e4c932e41782846e431deeb7d)
+- [Dev Deps] update `eslint`, `@ljharb/eslint-config`, `safe-publish-latest` [`4cedaa9`](https://github.com/ljharb/util.promisify/commit/4cedaa9c6b0a77a0416b69d480b3b806c00dec6e)
+- Adds usage information to the README [`ddb4556`](https://github.com/ljharb/util.promisify/commit/ddb45562320ab8aea93dc0364640ea21ab68bfbb)
+- [Dev Deps] update `eslint`, `@ljharb/eslint-config`, `safe-publish-latest` [`95362c0`](https://github.com/ljharb/util.promisify/commit/95362c0e93186a30ede6333430ddfa0606a769b4)
+- [Dev Deps] update `@es-shims/api`, `@ljharb/eslint-config`, `eslint` [`fd79a58`](https://github.com/ljharb/util.promisify/commit/fd79a58573186c83d81777fa0b1ad293b2f475e3)
+- [Dev Deps] update `eslint`, `@ljharb/eslint-config` [`2cf792b`](https://github.com/ljharb/util.promisify/commit/2cf792b9dcaab24b642ef1de8239ceb089fc5d38)
+- [Docs] Link to util.promisify-all [`032ff5c`](https://github.com/ljharb/util.promisify/commit/032ff5c6ee2958a02f56c770337441c3a587b88c)
+- [Tests] allow node 0.10 and 0.8 to fail again [`c2f8418`](https://github.com/ljharb/util.promisify/commit/c2f8418dfc36b83cd8a18b86a735c2936c6f5f9e)
+- [Tests] remove mistakenly added travis jobs [`13a242f`](https://github.com/ljharb/util.promisify/commit/13a242fb33dcbd4e2872436f2e430e62526fb147)
+- [Tests] on `node` `v10.1` [`8244578`](https://github.com/ljharb/util.promisify/commit/82445786197fd3e54aeffaa2fe0f1da38bcafec4)
+- [meta] add `funding` field [`e1645ca`](https://github.com/ljharb/util.promisify/commit/e1645ca10648d1ae917e3f5ae954b37de338dc20)
+- [New] add `auto` entry point [`2c48047`](https://github.com/ljharb/util.promisify/commit/2c480479d67646fb2bfb92a4e5d50ff14bcdca3c)
+- [Fix] use `has-symbols` package to ensure we support Symbol shams too. [`75135c8`](https://github.com/ljharb/util.promisify/commit/75135c8a48ea4e1be1cfe7a95af11905818303e7)
+- [Deps] update `es-abstract` [`32aa5cc`](https://github.com/ljharb/util.promisify/commit/32aa5ccd3ee7513edef99ed7d516d6c0f4901883)
+- [Dev Deps] update `eslint` [`c3043e6`](https://github.com/ljharb/util.promisify/commit/c3043e6e562847102e9136479268777bc07e9b26)
+- [Deps] update `object.getownpropertydescriptors` [`521ed25`](https://github.com/ljharb/util.promisify/commit/521ed25d40dc230b38ac3755036219fbaf94694c)
+- [Deps] update `has-symbol` [`16d91ec`](https://github.com/ljharb/util.promisify/commit/16d91ecc0016c31e49b7c3da938c19132c243732)
+- [Deps] update `define-properties` [`532915e`](https://github.com/ljharb/util.promisify/commit/532915ed58fe6f0edc3670837b510e09fb39b99a)
+- [Tests] `npm` v5+ breaks on node < v4 [`0647c63`](https://github.com/ljharb/util.promisify/commit/0647c63d932451c043c3e8f3b003c636057f035a)
+
+## v1.0.0 - 2017-05-30
+
+### Commits
+
+- Dotfiles. [`02c20cb`](https://github.com/ljharb/util.promisify/commit/02c20cb4eb01cf656102f57f71635785114f1d09)
+- Initial implementation. [`05ff048`](https://github.com/ljharb/util.promisify/commit/05ff0480448f019a85675ce81ecc4e9bdc099286)
+- Initial commit [`9472155`](https://github.com/ljharb/util.promisify/commit/947215502491bb1b3238aa0ac5c67258e41db3a8)
+- package.json [`e0302c0`](https://github.com/ljharb/util.promisify/commit/e0302c01e5e3b1dd78647303f9a4337b5bb63196)
+- Initial readme. [`5df78e1`](https://github.com/ljharb/util.promisify/commit/5df78e16e89e8328c61d6bbac85409a36560fe3b)
+- [Dev Deps] add `safe-publish-latest` [`596b6b4`](https://github.com/ljharb/util.promisify/commit/596b6b4fbce79dbaf5fff366454ab5b31d2eb993)
+- [Tests] add `npm run lint` [`54c2ccb`](https://github.com/ljharb/util.promisify/commit/54c2ccb85db682fc293b30a0bfece76d0a5c7c60)
+- [Dev Deps] add `@es-shims/api` [`d9014f1`](https://github.com/ljharb/util.promisify/commit/d9014f12add2fb3fe743647df614c69ed305a824)
+- [Tests] allow 0.10 and 0.8 to fail, for now. [`c5c7b61`](https://github.com/ljharb/util.promisify/commit/c5c7b619b88878fc715d1768b48bd45378c9f807)

implementation.js

 'use strict';
 
 var isES5 = typeof Object.defineProperty === 'function'
-	&& typeof Object.defineProperties === 'function'
-	&& typeof Object.getPrototypeOf === 'function'
-	&& typeof Object.setPrototypeOf === 'function';
+	&& typeof Object.defineProperties === 'function';
 
-if (!isES5) {
-	throw new TypeError('util.promisify requires a true ES5 environment');
+var hasProto = [].__proto__ === Array.prototype; // eslint-disable-line no-proto
+
+if (!isES5 || !hasProto) {
+	throw new TypeError('util.promisify requires a true ES5 environment, that also supports `__proto__`');
 }
@@ -18,8 +18,10 @@
 
-var slice = Function.call.bind(Array.prototype.slice);
-var concat = Function.call.bind(Array.prototype.concat);
-var forEach = Function.call.bind(Array.prototype.forEach);
+var callBound = require('es-abstract/helpers/callBound');
 
-var hasSymbols = typeof Symbol === 'function' && typeof Symbol('') === 'symbol';
+var $slice = callBound('Array.prototype.slice');
+var $concat = callBound('Array.prototype.concat');
+var $forEach = callBound('Array.prototype.forEach');
 
+var hasSymbols = require('has-symbols')();
+
 var kCustomPromisifiedSymbol = hasSymbols ? Symbol('util.promisify.custom') : null;
@@ -55,7 +57,7 @@ var kCustomPromisifyArgsSymbol = hasSymbols ? Symbol('customPromisifyArgs') : null;
 	var promisified = function fn() {
-		var args = slice(arguments);
+		var args = $slice(arguments);
 		var self = this; // eslint-disable-line no-invalid-this
 		return new Promise(function (resolve, reject) {
-			orig.apply(self, concat(args, function (err) {
-				var values = arguments.length > 1 ? slice(arguments, 1) : [];
+			orig.apply(self, $concat(args, function (err) {
+				var values = arguments.length > 1 ? $slice(arguments, 1) : [];
 				if (err) {
@@ -65,3 +67,3 @@ reject(err);
 					var obj = {};
-					forEach(argumentNames, function (name, index) {
+					$forEach(argumentNames, function (name, index) {
 						obj[name] = values[index];
@@ -77,3 +79,3 @@ });
 
-	Object.setPrototypeOf(promisified, Object.getPrototypeOf(orig));
+	promisified.__proto__ = orig.__proto__; // eslint-disable-line no-proto
 
@@ -80,0 +82,0 @@ Object.defineProperty(promisified, kCustomPromisifiedSymbol, {

package.json

 {
 	"name": "util.promisify",
-	"version": "1.0.0",
+	"version": "1.0.1",
 	"description": "Polyfill/shim for util.promisify in node versions < v8",
 	"main": "index.js",
 	"dependencies": {
-		"define-properties": "^1.1.2",
-		"object.getownpropertydescriptors": "^2.0.3"
+		"define-properties": "^1.1.3",
+		"es-abstract": "^1.17.2",
+		"has-symbols": "^1.0.1",
+		"object.getownpropertydescriptors": "^2.1.0"
 	},
 	"devDependencies": {
-		"@es-shims/api": "^1.2.0",
-		"@ljharb/eslint-config": "^11.0.0",
-		"eslint": "^3.19.0",
-		"safe-publish-latest": "^1.1.1"
+		"@es-shims/api": "^2.1.2",
+		"@ljharb/eslint-config": "^15.1.0",
+		"auto-changelog": "^1.16.2",
+		"eslint": "^6.8.0",
+		"safe-publish-latest": "^1.1.4"
 	},
@@ -21,3 +24,6 @@ "scripts": {
 		"tests-only": "es-shim-api --bound",
-		"test": "npm run tests-only"
+		"test": "npm run tests-only",
+		"posttest": "npx aud",
+		"version": "auto-changelog && git add CHANGELOG.md",
+		"postversion": "auto-changelog && git add CHANGELOG.md && git commit --no-edit --amend && git tag -f \"v$(node -e \"console.log(require('./package.json').version)\")\""
 	},
@@ -37,2 +43,5 @@ "repository": {
 	"author": "Jordan Harband <[e-mail]>",
+	"funding": {
+		"url": "https://github.com/sponsors/ljharb"
+	},
 	"license": "MIT",
@@ -42,3 +51,10 @@ "bugs": {
 	},
-	"homepage": "https://github.com/ljharb/util.promisify#readme"
+	"homepage": "https://github.com/ljharb/util.promisify#readme",
+	"auto-changelog": {
+		"output": "CHANGELOG.md",
+		"template": "keepachangelog",
+		"unreleased": false,
+		"commitLimit": false,
+		"backfillLimit": false
+	}
 }

README.md

@@ -8,2 +8,22 @@ # util.promisify
 
+## Usage
+
+**Direct**
+```js
+const promisify = require('util.promisify');
+// Use `promisify` just like the built-in method on `util`
+```
+
+**Shim**
+```js
+require('util.promisify/shim')();
+// `util.promisify` is now defined
+const util = require('util');
+// Use `util.promisify`
+```
+
 Note: this package requires a native ES5 environment, and for `Promise` to be globally available. It will throw upon requiring it if these are not present.
+
+## Promisifying modules
+
+If you want to promisify a whole module, like the `fs` module, you can use [`util.promisify-all`](https://www.npmjs.com/package/util.promisify-all).

shim.js

@@ -9,6 +9,10 @@ 'use strict';
 	if (polyfill !== util.promisify) {
-		util.promisify = polyfill;
-		Object.defineProperty(util, 'promisify', { value: polyfill });
+		Object.defineProperty(util, 'promisify', {
+			configurable: true,
+			enumerable: true,
+			value: polyfill,
+			writable: true
+		});
 	}
 	return polyfill;
 };

No alert changes

Improved metrics

Total package byte prevSize

14826

increased by11.57%

Number of package files

13

increased by18.18%

Lines of code

118

increased by5.36%

Number of lines in readme file

29

increased by222.22%

Worsened metrics

Dependency count

4

increased by100%

Dev dependency count

5

increased by25%

Dependency changes

• + Addedes-abstract@^1.17.2

• + Addedhas-symbols@^1.0.1

• Updateddefine-properties@^1.1.3

• Updatedobject.getownpropertydescriptors@^2.1.0