Require Node.js 12.20 and move to ESM

Author: sindresorhus

.github/workflows/main.yml

@@ -10,12 +10,12 @@ jobs:
       fail-fast: false
       matrix:
         node-version:
+          - 16
           - 14
           - 12
-          - 10
     steps:
       - uses: actions/checkout@v2
-      - uses: actions/setup-node@v1
+      - uses: actions/setup-node@v2
         with:
           node-version: ${{ matrix.node-version }}
       - run: npm install

index.d.ts

@@ -1,14 +1,11 @@
-/// <reference types="node"/>
-import {IncomingMessage, IncomingHttpHeaders} from 'http';
+import {IncomingMessage, IncomingHttpHeaders} from 'node:http';
 
-declare namespace decompressResponse {
-	interface UncompressedIncomingHttpHeaders extends IncomingHttpHeaders {
-		'content-encoding'?: never;
-	}
+export interface UncompressedIncomingHttpHeaders extends IncomingHttpHeaders {
+	'content-encoding'?: never;
+}
 
-	interface UncompressedIncomingMessage extends IncomingMessage {
-		headers: UncompressedIncomingHttpHeaders;
-	}
+export interface UncompressedIncomingMessage extends IncomingMessage {
+	headers: UncompressedIncomingHttpHeaders;
 }
 
 /**
@@ -19,14 +16,12 @@ Decompress a HTTP response if needed.
 
 @example
 ```
-import {http} from 'http';
-import decompressResponse = require('decompress-response');
+import http from 'node:http';
+import decompressResponse from 'decompress-response';
 
 http.get('https://sindresorhus.com', response => {
 	response = decompressResponse(response);
 });
 ```
 */
-declare function decompressResponse(response: IncomingMessage): decompressResponse.UncompressedIncomingMessage;
-
-export = decompressResponse;
+export default function decompressResponse(response: IncomingMessage): UncompressedIncomingMessage;

index.js

@@ -1,9 +1,8 @@
-'use strict';
-const {Transform, PassThrough} = require('stream');
-const zlib = require('zlib');
-const mimicResponse = require('mimic-response');
+import {Transform as TransformStream, PassThrough as PassThroughStream} from 'node:stream';
+import zlib from 'node:zlib';
+import mimicResponse from 'mimic-response';
 
-module.exports = response => {
+export default function decompressResponse(response) {
 	const contentEncoding = (response.headers['content-encoding'] || '').toLowerCase();
 
 	if (!['gzip', 'deflate', 'br'].includes(contentEncoding)) {
@@ -12,16 +11,9 @@ module.exports = response => {
 
 	delete response.headers['content-encoding'];
 
-	// TODO: Remove this when targeting Node.js 12.
-	const isBrotli = contentEncoding === 'br';
-	if (isBrotli && typeof zlib.createBrotliDecompress !== 'function') {
-		response.destroy(new Error('Brotli is not supported on Node.js < 12'));
-		return response;
-	}
-
 	let isEmpty = true;
 
-	const checker = new Transform({
+	const checker = new TransformStream({
 		transform(data, _encoding, callback) {
 			isEmpty = false;
 
@@ -30,19 +22,19 @@ module.exports = response => {
 
 		flush(callback) {
 			callback();
-		}
+		},
 	});
 
-	const finalStream = new PassThrough({
+	const finalStream = new PassThroughStream({
 		autoDestroy: false,
 		destroy(error, callback) {
 			response.destroy();
 
 			callback(error);
-		}
+		},
 	});
 
-	const decompressStream = isBrotli ? zlib.createBrotliDecompress() : zlib.createUnzip();
+	const decompressStream = contentEncoding === 'br' ? zlib.createBrotliDecompress() : zlib.createUnzip();
 
 	decompressStream.once('error', error => {
 		if (isEmpty && !response.readable) {
@@ -57,4 +49,4 @@ module.exports = response => {
 	response.pipe(checker).pipe(decompressStream).pipe(finalStream);
 
 	return finalStream;
-};
+}

index.test-d.ts

@@ -1,7 +1,7 @@
-import * as http from 'http';
+import http from 'node:http';
 import {expectType} from 'tsd';
-import decompressResponse = require('.');
+import decompressResponse, {UncompressedIncomingMessage} from './index.js';
 
 http.get('localhost', response => {
-	expectType<decompressResponse.UncompressedIncomingMessage>(decompressResponse(response));
+	expectType<UncompressedIncomingMessage>(decompressResponse(response));
 });

package.json

@@ -10,8 +10,10 @@
 		"email": "[email protected]",
 		"url": "https://sindresorhus.com"
 	},
+	"type": "module",
+	"exports": "./index.js",
 	"engines": {
-		"node": ">=10"
+		"node": "^12.20.0 || ^14.13.1 || >=16.0.0"
 	},
 	"scripts": {
 		"test": "xo && ava && tsd"
@@ -38,19 +40,15 @@
 		"brotli"
 	],
 	"dependencies": {
-		"mimic-response": "^3.1.0"
+		"mimic-response": "^4.0.0"
 	},
 	"devDependencies": {
-		"@types/node": "^14.0.1",
-		"ava": "^2.2.0",
-		"get-stream": "^5.0.0",
+		"@types/node": "^16.11.6",
+		"ava": "^3.15.0",
+		"get-stream": "^6.0.1",
 		"pify": "^5.0.0",
-		"tsd": "^0.11.0",
-		"xo": "^0.30.0"
-	},
-	"xo": {
-		"rules": {
-			"@typescript-eslint/prefer-readonly-parameter-types": "off"
-		}
+		"tsd": "^0.18.0",
+		"typescript": "^4.4.4",
+		"xo": "^0.45.0"
 	}
 }

readme.md

@@ -8,15 +8,15 @@ Used by [`got`](https://github.com/sindresorhus/got).
 
 ## Install
 
-```
-$ npm install decompress-response
+```sh
+npm install decompress-response
 ```
 
 ## Usage
 
 ```js
-const http = require('http');
-const decompressResponse = require('decompress-response');
+import http from 'node:http';
+import decompressResponse from 'decompress-response';
 
 http.get('https://sindresorhus.com', response => {
 	response = decompressResponse(response);

test/_server.js

@@ -1,4 +1,4 @@
-import http from 'http';
+import http from 'node:http';
 import pify from 'pify';
 
 export const host = 'localhost';

test/test.js

@@ -1,10 +1,10 @@
-import http from 'http';
-import zlib from 'zlib';
+import http from 'node:http';
+import zlib from 'node:zlib';
 import test from 'ava';
 import getStream from 'get-stream';
 import pify from 'pify';
-import {createServer} from './_server';
-import decompressResponse from '..';
+import decompressResponse from '../index.js';
+import {createServer} from './_server.js';
 
 const zlibP = pify(zlib);
 const httpGetP = pify(http.get, {errorFirst: false});
@@ -91,18 +91,16 @@ test('decompress deflated content', async t => {
 	t.is(await getStream(response), fixture);
 });
 
-if (typeof zlib.brotliCompress === 'function') {
-	test('decompress brotli content', async t => {
-		const response = decompressResponse(await httpGetP(`${server.url}/brotli`));
+test('decompress brotli content', async t => {
+	const response = decompressResponse(await httpGetP(`${server.url}/brotli`));
 
-		t.is(typeof response.httpVersion, 'string');
-		t.truthy(response.headers);
+	t.is(typeof response.httpVersion, 'string');
+	t.truthy(response.headers);
 
-		response.setEncoding('utf8');
+	response.setEncoding('utf8');
 
-		t.is(await getStream(response), fixture);
-	});
-}
+	t.is(await getStream(response), fixture);
+});
 
 test('does not ignore missing data', async t => {
 	const response = decompressResponse(await httpGetP(`${server.url}/missing-data`));
@@ -114,7 +112,7 @@ test('does not ignore missing data', async t => {
 
 	await t.throwsAsync(getStream(response), {
 		message: 'unexpected end of file',
-		code: 'Z_BUF_ERROR'
+		code: 'Z_BUF_ERROR',
 	});
 });