crc - npm Package Compare versions

Comparing version 4.0.0 to 4.1.0

crc1.d.ts

@@ -1,2 +0,2 @@
-declare const _default: import("./types").CRCModule;
+declare const _default: import("./types.js").CRCModule;
 export default _default;

crc16.d.ts

@@ -1,2 +0,2 @@
-declare const _default: import("./types").CRCModule;
+declare const _default: import("./types.js").CRCModule;
 export default _default;

crc16ccitt.d.ts

@@ -1,2 +0,2 @@
-declare const _default: import("./types").CRCModule;
+declare const _default: import("./types.js").CRCModule;
 export default _default;

crc16kermit.d.ts

@@ -1,2 +0,2 @@
-declare const _default: import("./types").CRCModule;
+declare const _default: import("./types.js").CRCModule;
 export default _default;

crc16modbus.d.ts

@@ -1,2 +0,2 @@
-declare const _default: import("./types").CRCModule;
+declare const _default: import("./types.js").CRCModule;
 export default _default;

crc16xmodem.d.ts

@@ -1,2 +0,2 @@
-declare const _default: import("./types").CRCModule;
+declare const _default: import("./types.js").CRCModule;
 export default _default;

crc24.d.ts

@@ -1,2 +0,2 @@
-declare const _default: import("./types").CRCModule;
+declare const _default: import("./types.js").CRCModule;
 export default _default;

crc32.d.ts

@@ -1,2 +0,2 @@
-declare const _default: import("./types").CRCModule;
+declare const _default: import("./types.js").CRCModule;
 export default _default;

crc8.d.ts

@@ -1,2 +0,2 @@
-declare const _default: import("./types").CRCModule;
+declare const _default: import("./types.js").CRCModule;
 export default _default;

crc81wire.d.ts

@@ -1,2 +0,2 @@
-declare const _default: import("./types").CRCModule;
+declare const _default: import("./types.js").CRCModule;
 export default _default;

crcjam.d.ts

@@ -1,2 +0,2 @@
-declare const _default: import("./types").CRCModule;
+declare const _default: import("./types.js").CRCModule;
 export default _default;

create_buffer.d.ts

 /// <reference types="node" />
 import { Buffer } from 'buffer';
-import { BufferInput } from './types';
+import { BufferInput } from './types.js';
 declare const createBuffer: (value: BufferInput, encoding?: BufferEncoding | undefined) => Buffer;
 export default createBuffer;

define_crc.d.ts

@@ -1,2 +0,2 @@
-import { CRCCalculator, CRCModule } from './types';
+import { CRCCalculator, CRCModule } from './types.js';
 export default function defineCrc(model: string, calculator: CRCCalculator<Uint8Array>): CRCModule;

index.d.ts

@@ -1,12 +0,12 @@
-import crc1 from './crc1';
-import crc8 from './crc8';
-import crc81wire from './crc81wire';
-import crc16 from './crc16';
-import crc16ccitt from './crc16ccitt';
-import crc16modbus from './crc16modbus';
-import crc16xmodem from './crc16xmodem';
-import crc16kermit from './crc16kermit';
-import crc24 from './crc24';
-import crc32 from './crc32';
-import crcjam from './crcjam';
+import crc1 from './crc1.js';
+import crc8 from './crc8.js';
+import crc81wire from './crc81wire.js';
+import crc16 from './crc16.js';
+import crc16ccitt from './crc16ccitt.js';
+import crc16modbus from './crc16modbus.js';
+import crc16xmodem from './crc16xmodem.js';
+import crc16kermit from './crc16kermit.js';
+import crc24 from './crc24.js';
+import crc32 from './crc32.js';
+import crcjam from './crcjam.js';
 export { crc1 };
@@ -24,14 +24,14 @@ export { crc8 };
 declare const _default: {
-    crc1: import("./types").CRCModule;
-    crc8: import("./types").CRCModule;
-    crc81wire: import("./types").CRCModule;
-    crc16: import("./types").CRCModule;
-    crc16ccitt: import("./types").CRCModule;
-    crc16modbus: import("./types").CRCModule;
-    crc16xmodem: import("./types").CRCModule;
-    crc16kermit: import("./types").CRCModule;
-    crc24: import("./types").CRCModule;
-    crc32: import("./types").CRCModule;
-    crcjam: import("./types").CRCModule;
+    crc1: import("./types.js").CRCModule;
+    crc8: import("./types.js").CRCModule;
+    crc81wire: import("./types.js").CRCModule;
+    crc16: import("./types.js").CRCModule;
+    crc16ccitt: import("./types.js").CRCModule;
+    crc16modbus: import("./types.js").CRCModule;
+    crc16xmodem: import("./types.js").CRCModule;
+    crc16kermit: import("./types.js").CRCModule;
+    crc24: import("./types.js").CRCModule;
+    crc32: import("./types.js").CRCModule;
+    crcjam: import("./types.js").CRCModule;
 };
 export default _default;

package.json

 {
   "name": "crc",
-  "version": "4.0.0",
+  "version": "4.1.0",
   "description": "Module for calculating Cyclic Redundancy Check (CRC) for Node.js and the Browser.",
@@ -27,5 +27,123 @@ "author": {
   ],
-  "main": "./lib/index.js",
-  "module": "./index.js",
-  "types": "./index.d.ts",
+  "type": "module",
+  "types": "./mjs/index.d.ts",
+  "main": "./cjs-default-unwrap/index.js",
+  "module": "./mjs/index.js",
+  "exports": {
+    ".": {
+      "types": "./mjs/index.d.ts",
+      "import": "./mjs/index.js",
+      "require": "./cjs-default-unwrap/index.js"
+    },
+    "./crc16ccitt": {
+      "types": "./mjs/crc16ccitt.d.ts",
+      "import": "./mjs/crc16ccitt.js",
+      "require": "./cjs-default-unwrap/crc16ccitt.js"
+    },
+    "./calculators/crc16ccitt": {
+      "types": "./mjs/calculators/crc16ccitt.d.ts",
+      "import": "./mjs/calculators/crc16ccitt.js",
+      "require": "./cjs-default-unwrap/calculators/crc16ccitt.js"
+    },
+    "./crc16kermit": {
+      "types": "./mjs/crc16kermit.d.ts",
+      "import": "./mjs/crc16kermit.js",
+      "require": "./cjs-default-unwrap/crc16kermit.js"
+    },
+    "./calculators/crc16kermit": {
+      "types": "./mjs/calculators/crc16kermit.d.ts",
+      "import": "./mjs/calculators/crc16kermit.js",
+      "require": "./cjs-default-unwrap/calculators/crc16kermit.js"
+    },
+    "./crc16modbus": {
+      "types": "./mjs/crc16modbus.d.ts",
+      "import": "./mjs/crc16modbus.js",
+      "require": "./cjs-default-unwrap/crc16modbus.js"
+    },
+    "./calculators/crc16modbus": {
+      "types": "./mjs/calculators/crc16modbus.d.ts",
+      "import": "./mjs/calculators/crc16modbus.js",
+      "require": "./cjs-default-unwrap/calculators/crc16modbus.js"
+    },
+    "./crc16": {
+      "types": "./mjs/crc16.d.ts",
+      "import": "./mjs/crc16.js",
+      "require": "./cjs-default-unwrap/crc16.js"
+    },
+    "./calculators/crc16": {
+      "types": "./mjs/calculators/crc16.d.ts",
+      "import": "./mjs/calculators/crc16.js",
+      "require": "./cjs-default-unwrap/calculators/crc16.js"
+    },
+    "./crc16xmodem": {
+      "types": "./mjs/crc16xmodem.d.ts",
+      "import": "./mjs/crc16xmodem.js",
+      "require": "./cjs-default-unwrap/crc16xmodem.js"
+    },
+    "./calculators/crc16xmodem": {
+      "types": "./mjs/calculators/crc16xmodem.d.ts",
+      "import": "./mjs/calculators/crc16xmodem.js",
+      "require": "./cjs-default-unwrap/calculators/crc16xmodem.js"
+    },
+    "./crc1": {
+      "types": "./mjs/crc1.d.ts",
+      "import": "./mjs/crc1.js",
+      "require": "./cjs-default-unwrap/crc1.js"
+    },
+    "./calculators/crc1": {
+      "types": "./mjs/calculators/crc1.d.ts",
+      "import": "./mjs/calculators/crc1.js",
+      "require": "./cjs-default-unwrap/calculators/crc1.js"
+    },
+    "./crc24": {
+      "types": "./mjs/crc24.d.ts",
+      "import": "./mjs/crc24.js",
+      "require": "./cjs-default-unwrap/crc24.js"
+    },
+    "./calculators/crc24": {
+      "types": "./mjs/calculators/crc24.d.ts",
+      "import": "./mjs/calculators/crc24.js",
+      "require": "./cjs-default-unwrap/calculators/crc24.js"
+    },
+    "./crc32": {
+      "types": "./mjs/crc32.d.ts",
+      "import": "./mjs/crc32.js",
+      "require": "./cjs-default-unwrap/crc32.js"
+    },
+    "./calculators/crc32": {
+      "types": "./mjs/calculators/crc32.d.ts",
+      "import": "./mjs/calculators/crc32.js",
+      "require": "./cjs-default-unwrap/calculators/crc32.js"
+    },
+    "./crc81wire": {
+      "types": "./mjs/crc81wire.d.ts",
+      "import": "./mjs/crc81wire.js",
+      "require": "./cjs-default-unwrap/crc81wire.js"
+    },
+    "./calculators/crc81wire": {
+      "types": "./mjs/calculators/crc81wire.d.ts",
+      "import": "./mjs/calculators/crc81wire.js",
+      "require": "./cjs-default-unwrap/calculators/crc81wire.js"
+    },
+    "./crc8": {
+      "types": "./mjs/crc8.d.ts",
+      "import": "./mjs/crc8.js",
+      "require": "./cjs-default-unwrap/crc8.js"
+    },
+    "./calculators/crc8": {
+      "types": "./mjs/calculators/crc8.d.ts",
+      "import": "./mjs/calculators/crc8.js",
+      "require": "./cjs-default-unwrap/calculators/crc8.js"
+    },
+    "./crcjam": {
+      "types": "./mjs/crcjam.d.ts",
+      "import": "./mjs/crcjam.js",
+      "require": "./cjs-default-unwrap/crcjam.js"
+    },
+    "./calculators/crcjam": {
+      "types": "./mjs/calculators/crcjam.d.ts",
+      "import": "./mjs/calculators/crcjam.js",
+      "require": "./cjs-default-unwrap/calculators/crcjam.js"
+    }
+  },
   "sideEffects": false,
@@ -36,40 +154,12 @@ "engines": {
   "files": [
-    "lib",
+    "calculators",
+    "cjs",
+    "cjs-default-unwrap",
+    "mjs",
     "*.js",
     "*.d.ts"
   ],
-  "scripts": {
-    "lint": "eslint src/{,**/}*.ts test/{,**/}*.ts",
-    "test": "./scripts/test",
-    "build": "./scripts/build",
-    "benchmark": "./scripts/benchmark",
-    "prepack": "./scripts/prepack"
-  },
   "peerDependencies": {
     "buffer": ">=6.0.3"
-  },
-  "devDependencies": {
-    "@types/chai": "^4.3.0",
-    "@types/mocha": "^9.0.0",
-    "@types/prettier": "^2.4.2",
-    "@typescript-eslint/eslint-plugin": "^5.8.0",
-    "@typescript-eslint/parser": "^5.8.0",
-    "beautify-benchmark": "^0.2.4",
-    "benchmark": "^2.1.4",
-    "buffer-crc32": "^0.2.13",
-    "chai": "^4.3.4",
-    "eslint": "^8.5.0",
-    "eslint-config-airbnb-base": "^15.0.0",
-    "eslint-config-prettier": "^8.3.0",
-    "eslint-config-typescript": "^3.0.0",
-    "eslint-formatter-pretty": "^4.0.0",
-    "eslint-plugin-import": "^2.25.3",
-    "eslint-plugin-no-only-tests": "^2.6.0",
-    "eslint-plugin-prettier": "^4.0.0",
-    "mocha": "^9.1.3",
-    "prettier": "^2.5.1",
-    "seedrandom": "^3.0.5",
-    "ts-node": "^10.4.0",
-    "typescript": "^4.5.4"
   }
 }

README.md

@@ -8,5 +8,5 @@ # crc
 - Written in TypeScript and provides typings out of the box.
+- Supports ESM and CommonJS.
 - Pure JavaScript implementation, no native dependencies.
 - Full test suite using `pycrc` as a refenrence.
-- ES6 modules.
 - Supports for the following CRC algorithms:
@@ -33,3 +33,3 @@ - CRC1 (`crc1`)
 
-Calculate a CRC32 (recommended way):
+Using specific CRC is the recommended way to reduce bundle size:
 
@@ -42,3 +42,3 @@ ```js
 
-Import everything (this will increase bundle size if a bundler is used):
+Alternatively you can use main default export:
 
@@ -51,3 +51,3 @@ ```js
 
-If you wish to minimize bundle size (meaning avoid `Buffer` being a dependency), you can import CRC calculators directly and pass an instance of `Int8Array` into it:
+If you really wish to minimize bundle size, you can import CRC calculators directly and pass an instance of `Int8Array`:
 
@@ -61,6 +61,14 @@ ```js
 
+CommonJS is supported as well without the need to unwrap `.default`:
+
+```js
+const crc32 = require('crc/crc32');
+crc32('hello').toString(16);
+// "3610a686"
+```
+
 Calculate a CRC32 of a file:
 
 ```js
-crc32(fs.readFileSync('README.md', 'utf8')).toString(16);
+crc32(fs.readFileSync('README.md', 'utf-8')).toString(16);
 // "127ad531"
@@ -72,3 +80,3 @@ ```
 ```js
-crc32(fs.readFileSync('README.md', 'utf8')).toString(16);
+crc32(fs.readFileSync('README.md', 'utf-8')).toString(16);
 // "127ad531"
@@ -80,3 +88,3 @@ ```
 ```js
-value = crc32('one');
+let value = crc32('one');
 value = crc32('two', value);
@@ -88,3 +96,3 @@ value = crc32('three', value);
 
-## Running tests
+## Tests
 
@@ -91,0 +99,0 @@ ```

New alerts

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 tests

Quality

Package does not have any tests. This is a strong signal of a poorly maintained or low quality package.

Found 1 instance in 1 package

Fixed alerts

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

Improved metrics

Dev dependency count

0

decreased by-100%

Number of package files

135

increased by32.35%

Lines of code

1247

increased by33.08%

Number of lines in readme file

122

increased by7.02%

Is type module

Yes

Worsened metrics

Total package byte prevSize

82579

decreased by-23.51%

Number of low quality alerts

1

increased byInfinity%

No dependency changes