trivial-deferred - npm Package Compare versions

Comparing version 1.0.1 to 1.1.0

package.json

 {
   "name": "trivial-deferred",
-  "version": "1.0.1",
+  "version": "1.1.0",
+  "files": [
+    "dist"
+  ],
   "description": "The most dead-simple trivial Deferred implementation",
-  "main": "index.js",
-  "dependencies": {},
+  "main": "./dist/cjs/index-cjs.js",
+  "module": "./dist/mjs/index.js",
+  "types": "./dist/mjs/index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/mjs/index.d.ts",
+        "default": "./dist/mjs/index.js"
+      },
+      "require": {
+        "types": "./dist/cjs/index.d.ts",
+        "default": "./dist/cjs/index-cjs.js"
+      }
+    }
+  },
   "devDependencies": {
-    "tap": "9||10"
+    "@types/node": "^18.11.18",
+    "@types/tap": "^15.0.7",
+    "c8": "^7.12.0",
+    "prettier": "^2.8.3",
+    "tap": "^16.3.4",
+    "ts-node": "^10.9.1",
+    "typedoc": "^0.23.24",
+    "typescript": "^4.9.4"
   },
   "scripts": {
-    "test": "tap test.js --100"
+    "test": "c8 tap",
+    "snap": "c8 tap",
+    "preversion": "npm test",
+    "postversion": "npm publish",
+    "prepublishOnly": "git push origin --follow-tags",
+    "preprepare": "rm -rf dist",
+    "prepare": "tsc -p tsconfig.json && tsc -p tsconfig-esm.json",
+    "postprepare": "bash fixup.sh",
+    "pretest": "npm run prepare",
+    "presnap": "npm run prepare",
+    "format": "prettier --write . --loglevel warn",
+    "typedoc": "typedoc --tsconfig tsconfig-esm.json ./src/*.ts"
   },
+  "prettier": {
+    "semi": false,
+    "printWidth": 75,
+    "tabWidth": 2,
+    "useTabs": false,
+    "singleQuote": true,
+    "jsxSingleQuote": false,
+    "bracketSameLine": true,
+    "arrowParens": "avoid",
+    "endOfLine": "lf"
+  },
   "repository": {
@@ -17,9 +62,20 @@ "type": "git",
   },
-  "keywords": [],
+  "keywords": [
+    "deferred",
+    "promise"
+  ],
   "author": "Isaac Z. Schlueter <[e-mail]> (http://blog.izs.me/)",
   "license": "ISC",
-  "bugs": {
-    "url": "https://github.com/isaacs/trivial-deferred/issues"
+  "tap": {
+    "coverage": false,
+    "node-arg": [
+      "--no-warnings",
+      "--loader",
+      "ts-node/esm"
+    ],
+    "ts": false
   },
-  "homepage": "https://github.com/isaacs/trivial-deferred#readme"
+  "engines": {
+    "node": ">= 8"
+  }
 }

README.md

 # trivial-deferred
 
-The most dead-simple trivial Deferred implementation
+A very dead-simple trivial Deferred implementation
 
-Uses bluebird if available, otherwise native promises.
-
 ## USAGE
 
-```js
-var Deferred = require('trivial-deferred')
-var d = new Deferred
+```ts
+// hybrid module, either esm or cjs styles work
+import Deferred from 'trivial-deferred'
+// or
+const Deferred = require('trivial-deferred')
+// or even
+import Deferred from 'https://unpkg.com/trivial-deferred/dist/mjs/index.js'
+
+// or if you like this way better, this works, too:
+import { Deferred } from 'trivial-deferred'
+const { Deferred } = require('trivial-deferred')
+import { Deferred } from 'https://unpkg.com/trivial-deferred/dist/mjs/index.js'
+
+// type defaults to `unknown`, just like Promise<T>
+// set to <void> to make TypeScript ok with calling d.resolve()
+// with no argument.
+const d = new Deferred<string>()
 // promise is d.promise
 // to make the promise reject, do d.reject(error)
 // to make the promise resolve, do d.resolve(value)
+d.resolve('a string')
+assert.equal(await d.promise, 'a string')
 ```
+
+That's about it!

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

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

No bug tracker

Maintenance

Package does not have a linked bug tracker in package.json.

Found 1 instance in 1 package

No website

Quality

Package does not have a website.

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

8873

increased by268.94%

Number of package files

17

increased by183.33%

Lines of code

121

increased by303.33%

Number of lines in readme file

32

increased by100%

Worsened metrics

Dev dependency count

8

increased by700%

Number of low maintenance alerts

1

increased byInfinity%

Number of low quality alerts

1

increased byInfinity%

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes