sonic-boom - npm Package Compare versions

Comparing version 1.4.1 to 2.0.0

index.js

@@ -5,3 +5,2 @@ 'use strict'
 const EventEmitter = require('events')
-const flatstr = require('flatstr')
 const inherits = require('util').inherits
@@ -346,3 +345,2 @@
   }
-  flatstr(buf)
   sonic._writingBuf = buf
@@ -382,2 +380,14 @@ if (sonic.sync) {
 
+/**
+ * These export configurations enable JS and TS developers
+ * to consumer SonicBoom in whatever way best suits their needs.
+ * Some examples of supported import syntax includes:
+ * - `const SonicBoom = require('SonicBoom')`
+ * - `const { SonicBoom } = require('SonicBoom')`
+ * - `import * as SonicBoom from 'SonicBoom'`
+ * - `import { SonicBoom } from 'SonicBoom'`
+ * - `import SonicBoom from 'SonicBoom'`
+ */
+SonicBoom.SonicBoom = SonicBoom
+SonicBoom.default = SonicBoom
 module.exports = SonicBoom

package.json

 {
   "name": "sonic-boom",
-  "version": "1.4.1",
+  "version": "2.0.0",
   "description": "Extremely fast utf8 only stream implementation",
   "main": "index.js",
+  "type": "commonjs",
+  "types": "types/index.d.ts",
   "scripts": {
-    "test-only": "tap test.js",
-    "test": "standard && tap test.js",
+    "test": "npm run test:types && standard && tap test.js",
+    "test:unit": "tap test.js",
+    "test:types": "tsc && tsd",
     "prepare": "husky install"
@@ -13,3 +16,3 @@ },
     "type": "git",
-    "url": "git+https://github.com/mcollina/sonic-boom.git"
+    "url": "git+https://github.com/pinojs/sonic-boom.git"
   },
@@ -28,6 +31,7 @@ "keywords": [
   "bugs": {
-    "url": "https://github.com/mcollina/sonic-boom/issues"
+    "url": "https://github.com/pinojs/sonic-boom/issues"
   },
-  "homepage": "https://github.com/mcollina/sonic-boom#readme",
+  "homepage": "https://github.com/pinojs/sonic-boom#readme",
   "devDependencies": {
+    "@types/node": "^15.3.0",
     "fastbench": "^1.0.1",
@@ -37,3 +41,5 @@ "husky": "^6.0.0",
     "standard": "^16.0.3",
-    "tap": "^15.0.1"
+    "tap": "^15.0.1",
+    "tsd": "^0.15.1",
+    "typescript": "^4.2.4"
   },
@@ -48,3 +54,6 @@ "dependencies": {
     }
+  },
+  "tsd": {
+    "directory": "./types"
   }
 }

README.md

@@ -1,3 +0,8 @@
-# sonic-boom  ![Node.js CI](https://github.com/mcollina/sonic-boom/workflows/Node.js%20CI/badge.svg)
+# sonic-boom
 
+[![NPM Package Version](https://img.shields.io/npm/v/sonic-boom)](https://www.npmjs.com/package/sonic-boom)
+[![Build Status](https://github.com/pinojs/sonic-boom/workflows/Node.js%20CI/badge.svg)](https://github.com/pinojs/sonic-boom/actions?query=workflow%3ANode.js%20CI)
+[![Known Vulnerabilities](https://snyk.io/test/github/pinojs/sonic-boom/badge.svg)](https://snyk.io/test/github/pinojs/sonic-boom)
+[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](https://standardjs.com/)
+
 Extremely fast utf8-only stream implementation to write to files and
@@ -4,0 +9,0 @@ file descriptors.

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

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

156518

increased by308.24%

Number of package files

22

increased by69.23%

Lines of code

1230

increased by4.15%

Number of lines in readme file

107

increased by4.9%

Worsened metrics

Dev dependency count

8

increased by60%

No dependency changes