it-pair - npm Package Compare versions

Comparing version 2.0.2 to 2.0.3

dist/src/duplex.d.ts

 import type { Duplex } from 'it-stream-types';
+/**
+ * Two duplex streams that are attached to each other
+ */
 export declare function duplexPair<T>(): [Duplex<T>, Duplex<T>];
 //# sourceMappingURL=duplex.d.ts.map

dist/src/duplex.js

 import { pair } from './index.js';
+/**
+ * Two duplex streams that are attached to each other
+ */
 export function duplexPair() {
@@ -3,0 +6,0 @@ const a = pair();

dist/src/index.d.ts

 import type { Duplex } from 'it-stream-types';
+/**
+ * A pair of streams where one drains from the other
+ */
 export declare function pair<T>(): Duplex<T>;
 //# sourceMappingURL=index.d.ts.map

dist/src/index.js

 import defer from 'p-defer';
-// a pair of streams where one drains from the other
+/**
+ * A pair of streams where one drains from the other
+ */
 export function pair() {
@@ -4,0 +6,0 @@ const deferred = defer();

package.json

 {
   "name": "it-pair",
+  "version": "2.0.3",
   "description": "pair a source async iterable stream and a sink async iterable stream",
-  "version": "2.0.2",
-  "homepage": "https://github.com/alanshaw/it-pair",
+  "author": "Alan Shaw",
+  "license": "Apache-2.0 OR MIT",
+  "homepage": "https://github.com/alanshaw/it-pair#readme",
   "repository": {
     "type": "git",
-    "url": "git://github.com/alanshaw/it-pair.git"
+    "url": "git+https://github.com/alanshaw/it-pair.git"
   },
+  "bugs": {
+    "url": "https://github.com/alanshaw/it-pair/issues"
+  },
+  "engines": {
+    "node": ">=16.0.0",
+    "npm": ">=7.0.0"
+  },
   "type": "module",
@@ -16,7 +25,11 @@ "types": "./dist/src/index.d.ts",
         "*",
-        "*/index",
         "dist/*",
-        "dist/*/index",
         "dist/src/*",
         "dist/src/*/index"
+      ],
+      "src/*": [
+        "*",
+        "dist/*",
+        "dist/src/*",
+        "dist/src/*/index"
       ]
@@ -33,5 +46,7 @@ }
     ".": {
+      "types": "./dist/src/index.d.ts",
       "import": "./dist/src/index.js"
     },
     "./duplex": {
+      "types": "./dist/src/duplex.d.ts",
       "import": "./dist/src/duplex.js"
@@ -73,11 +88,11 @@ }
             {
-              "type": "chore",
+              "type": "docs",
               "release": "patch"
             },
             {
-              "type": "docs",
+              "type": "test",
               "release": "patch"
             },
             {
-              "type": "test",
+              "type": "deps",
               "release": "patch"
@@ -112,5 +127,9 @@ },
                 "type": "docs",
-                "section": "Trivial Changes"
+                "section": "Documentation"
               },
               {
+                "type": "deps",
+                "section": "Dependencies"
+              },
+              {
                 "type": "test",
@@ -131,26 +150,23 @@ "section": "Tests"
     "lint": "aegir lint",
-    "dep-check": "aegir dep-check dist/src/**/*.js dist/test/**/*.js",
-    "build": "tsc",
-    "pretest": "npm run build",
-    "test": "aegir test -f ./dist/test",
-    "test:chrome": "npm run test -- -t browser --cov",
-    "test:chrome-webworker": "npm run test -- -t webworker",
-    "test:firefox": "npm run test -- -t browser -- --browser firefox",
-    "test:firefox-webworker": "npm run test -- -t webworker -- --browser firefox",
-    "test:node": "npm run test -- -t node --cov",
-    "test:electron-main": "npm run test -- -t electron-main",
-    "release": "semantic-release"
+    "dep-check": "aegir dep-check",
+    "build": "aegir build",
+    "test": "aegir test",
+    "test:chrome": "aegir test -t browser --cov",
+    "test:chrome-webworker": "aegir test -t webworker",
+    "test:firefox": "aegir test -t browser -- --browser firefox",
+    "test:firefox-webworker": "aegir test -t webworker -- --browser firefox",
+    "test:node": "aegir test -t node --cov",
+    "test:electron-main": "aegir test -t electron-main",
+    "release": "aegir release"
   },
+  "dependencies": {
+    "it-stream-types": "^1.0.3",
+    "p-defer": "^4.0.0"
+  },
   "devDependencies": {
-    "aegir": "^36.1.3",
+    "aegir": "^37.4.8",
     "it-all": "^1.0.6",
     "it-drain": "^1.0.5",
     "it-pipe": "^2.0.0"
-  },
-  "author": "Alan Shaw",
-  "license": "MIT",
-  "dependencies": {
-    "it-stream-types": "^1.0.3",
-    "p-defer": "^4.0.0"
   }
 }

README.md

@@ -1,7 +0,20 @@
-# it-pair
+# it-pair <!-- omit in toc -->
 
-[![Build Status](https://github.com/alanshaw/it-pair/actions/workflows/js-test-and-release.yml/badge.svg?branch=master)](https://github.com/alanshaw/it-pair/actions/workflows/js-test-and-release.yml)
-[![Dependencies Status](https://status.david-dm.org/gh/alanshaw/it-pair.svg)](https://david-dm.org/alanshaw/it-pair)
-[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
+[![codecov](https://img.shields.io/codecov/c/github/alanshaw/it-pair.svg?style=flat-square)](https://codecov.io/gh/alanshaw/it-pair)
+[![CI](https://img.shields.io/github/workflow/status/alanshaw/it-pair/test%20&%20maybe%20release/master?style=flat-square)](https://github.com/alanshaw/it-pair/actions/workflows/js-test-and-release.yml)
 
+> pair a source async iterable stream and a sink async iterable stream
+
+## Table of contents <!-- omit in toc -->
+
+- [Install](#install)
+- [License](#license)
+- [Contribution](#contribution)
+
+## Install
+
+```console
+$ npm i it-pair
+```
+
 A pair of {source, sink} streams that are internally connected,
@@ -12,3 +25,3 @@ (what goes into the sink comes out the source)
 
-``` js
+```js
 import { pipe } from 'it-pipe'
@@ -38,3 +51,3 @@ import { pair } from 'it-pair'
 
-``` js
+```js
 import { duplexPair } from 'it-pair/duplex'
@@ -70,2 +83,9 @@
 
-MIT
+Licensed under either of
+
+- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>)
+- MIT ([LICENSE-MIT](LICENSE-MIT) / <http://opensource.org/licenses/MIT>)
+
+## Contribution
+
+Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

src/duplex.ts

 import { pair } from './index.js'
 import type { Duplex } from 'it-stream-types'
 
+/**
+ * Two duplex streams that are attached to each other
+ */
 export function duplexPair <T> (): [Duplex<T>, Duplex<T>] {
@@ -5,0 +8,0 @@ const a = pair<T>()

src/index.ts

 import defer from 'p-defer'
 import type { Source, Duplex } from 'it-stream-types'
 
-// a pair of streams where one drains from the other
+/**
+ * A pair of streams where one drains from the other
+ */
 export function pair <T> (): Duplex<T> {
@@ -6,0 +8,0 @@ const deferred = defer<Source<T>>()

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

Unidentified License

License

(Experimental) Something that seems like a license was found, but its contents could not be matched with a known license.

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

No bug tracker

Maintenance

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

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

10050

increased by2.89%

Lines of code

90

increased by21.62%

Number of low maintenance alerts

0

decreased by-100%

Number of lines in readme file

89

increased by28.99%

Worsened metrics

Number of low license alerts

1

increased byInfinity%

License quality

80

decreased by-20%

No dependency changes