compress-brotli - npm Package Compare versions

Comparing version 1.3.1 to 1.3.2

CHANGELOG.md

@@ -5,2 +5,4 @@ # Changelog
 
+### 1.3.2 (2021-08-21)
+
 ### 1.3.1 (2021-08-21)
@@ -7,0 +9,0 @@

package.json

@@ -5,4 +5,4 @@ {
   "homepage": "https://nicedoc.io/Kikobeats/compress-brotli",
-  "version": "1.3.1",
-  "main": "index.js",
+  "version": "1.3.2",
+  "main": "src/index.js",
   "author": {
@@ -34,2 +34,3 @@ "email": "[e-mail]",
   "dependencies": {
+    "@types/json-buffer": "~3.0.0",
     "json-buffer": "~3.0.1"
@@ -45,3 +46,2 @@ },
     "git-authors-cli": "latest",
-    "iltorb": "latest",
     "lint-staged": "latest",
@@ -52,2 +52,3 @@ "npm-check-updates": "latest",
     "simple-git-hooks": "latest",
+    "sinon": "latest",
     "standard": "latest",
@@ -61,3 +62,3 @@ "standard-markdown": "latest",
   "files": [
-    "index.js"
+    "src"
   ],
@@ -98,3 +99,4 @@ "scripts": {
     "pre-commit": "npx lint-staged"
-  }
+  },
+  "types": "src/index.d.ts"
 }

README.md

@@ -44,3 +44,42 @@ # compress-brotli
 ```
+customizing compress options:
+```js
+const createCompress = require('compress-brotli')
 
+const {
+  constants: {
+    BROTLI_MODE_TEXT,
+    BROTLI_PARAM_MODE,
+    BROTLI_PARAM_QUALITY
+  }
+} = require('zlib')
+
+// Provide factory level default options
+const { compress, decompress } = createCompress({
+  compressOptions: {
+    chunkSize: 1024,
+    parameters: {
+      [BROTLI_PARAM_MODE]: BROTLI_MODE_TEXT
+    }
+  },
+  decompressOptions: {
+    chunkSize: 1024,
+    parameters: {
+      [BROTLI_PARAM_MODE]: BROTLI_MODE_TEXT
+    }
+  }
+})
+const data = 'whatever'
+
+// Override call level options (deep merge for parameters)
+const compressed = compress(data, {
+  parameters: {
+    [BROTLI_PARAM_QUALITY]: 7
+  }
+})
+decompress(compressed, {
+  chunkSize: 2048
+})
+```
+
 ## API
@@ -71,2 +110,16 @@
 
+#### compressOptions
+
+Type: `zlib.BrotliOptions`<br>
+Default: `{}` i.e. default *zlib.brotliCompress* options will be used
+
+It  defines default options to be used in wrapped *zlib.brotliCompress* call
+
+#### decompressOptions
+
+Type: `zlib.BrotliOptions`<br>
+Default: `{}` i.e. default *zlib.brotliDecompress* options will be used
+
+It defines default options to be used in wrapped *zlib.brotliDecompress* call
+
 ## License
@@ -73,0 +126,0 @@

No alert changes

Improved metrics

Total package byte prevSize

12582

increased by29.02%

Number of package files

7

increased by40%

Lines of code

82

increased by148.48%

Number of lines in readme file

129

increased by69.74%

Worsened metrics

Dependency count

2

increased by100%

Dependency changes

• + Added@types/json-buffer@~3.0.0

• + Added@types/json-buffer@3.0.2(transitive)