@fastify/compress - npm Package Compare versions

Comparing version 6.2.1 to 6.3.0

index.js

@@ -9,3 +9,3 @@ 'use strict'
 const peek = require('peek-stream')
-const Minipass = require('minipass')
+const { Minipass } = require('minipass')
 const pumpify = require('pumpify')
@@ -111,2 +111,4 @@ const encodingNegotiator = require('@fastify/accept-negotiator')
 
+const defaultCompressibleTypes = /^text\/(?!event-stream)|\+json$|\+text$|\+xml$|octet-stream$/
+
 function processCompressParams (opts) {
@@ -128,3 +130,7 @@ /* istanbul ignore next */
   params.threshold = typeof opts.threshold === 'number' ? opts.threshold : 1024
-  params.compressibleTypes = opts.customTypes instanceof RegExp ? opts.customTypes : /^text\/(?!event-stream)|\+json$|\+text$|\+xml$|octet-stream$/
+  params.compressibleTypes = opts.customTypes instanceof RegExp
+    ? opts.customTypes.test.bind(opts.customTypes)
+    : typeof opts.customTypes === 'function'
+      ? opts.customTypes
+      : defaultCompressibleTypes.test.bind(defaultCompressibleTypes)
   params.compressStream = {
@@ -467,3 +473,3 @@ br: () => ((opts.zlib || zlib).createBrotliCompress || zlib.createBrotliCompress)(params.brotliOptions),
 function shouldCompress (type, compressibleTypes) {
-  if (compressibleTypes.test(type)) return true
+  if (compressibleTypes(type)) return true
   const data = mimedb[type.split(';', 1)[0].trim().toLowerCase()]
@@ -470,0 +476,0 @@ if (data === undefined) return false

package.json

 {
   "name": "@fastify/compress",
-  "version": "6.2.1",
+  "version": "6.3.0",
   "description": "Fastify compression utils",
@@ -12,3 +12,3 @@ "main": "index.js",
     "mime-db": "^1.51.0",
-    "minipass": "^4.0.0",
+    "minipass": "^5.0.0",
     "peek-stream": "^1.1.3",
@@ -20,3 +20,3 @@ "pump": "^3.0.0",
     "@fastify/pre-commit": "^2.0.2",
-    "@types/node": "^18.0.0",
+    "@types/node": "^20.1.0",
     "@typescript-eslint/eslint-plugin": "^5.9.0",
@@ -23,0 +23,0 @@ "@typescript-eslint/parser": "^5.9.0",

README.md

@@ -102,3 +102,4 @@ # @fastify/compress
 ### customTypes
-[mime-db](https://github.com/jshttp/mime-db) is used to determine if a `content-type` should be compressed. You can compress additional content types via regular expression.
+[mime-db](https://github.com/jshttp/mime-db) is used to determine if a `content-type` should be compressed. You can compress additional content types via regular expression or by providing a function.
+
 ```javascript
@@ -111,2 +112,11 @@ await fastify.register(
 
+or
+
+```javascript
+await fastify.register(
+  import('@fastify/compress'),
+  { customTypes: contentType => contentType.endsWith('x-protobuf') }
+)
+```
+
 ### onUnsupportedEncoding
@@ -113,0 +123,0 @@ When the encoding is not supported, a custom error response can be sent in place of the uncompressed payload by setting the `onUnsupportedEncoding(encoding, request, reply)` option to be a function that can modify the reply and return a `string | Buffer | Stream | Error` payload.

types/index.d.ts

@@ -62,2 +62,4 @@ import {
 
+type CompressibleContentTypeFunction = (contentType: string) => boolean;
+
 declare namespace fastifyCompress {
@@ -67,3 +69,3 @@
     brotliOptions?: BrotliOptions;
-    customTypes?: RegExp;
+    customTypes?: RegExp | CompressibleContentTypeFunction;
     encodings?: EncodingToken[];
@@ -70,0 +72,0 @@ forceRequestEncoding?: EncodingToken;

types/index.test-d.ts

@@ -31,2 +31,6 @@ import fastify, { FastifyInstance } from 'fastify'
 
+app.register(fastifyCompress, {
+  customTypes: value => value === 'application/json'
+})
+
 app.get('/test-one', async (request, reply) => {
@@ -33,0 +37,0 @@ expectType<void>(reply.compress(stream))

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

163825

increased by1.33%

Lines of code

4327

increased by1.15%

Number of lines in readme file

318

increased by3.25%

Dependency changes

• + Addedminipass@5.0.0(transitive)

• - Removedminipass@4.2.8(transitive)

• Updatedminipass@^5.0.0