Skip to content

Commit ca6398e

Browse files
committed
Export types to allow better completion
1 parent 563ce39 commit ca6398e

File tree

3 files changed

+7
-7
lines changed

3 files changed

+7
-7
lines changed

README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ An esbuild plugin to compress output using gzip, brotli, and deflate. Based on [
88
## Install
99

1010
```shell
11-
npm install esbuild-plugin-compress --save-dev
11+
npm install @liber-ufpe/esbuild-plugin-compress --save-dev
1212
```
1313

1414
## Usage
@@ -18,7 +18,7 @@ npm install esbuild-plugin-compress --save-dev
1818
1919
```javascript
2020
import esbuild from "esbuild";
21-
import compressPlugin from "esbuild-plugin-compress";
21+
import compressPlugin from "@liber-ufpe/esbuild-plugin-compress";
2222

2323
const compress = compressPlugin();
2424

@@ -35,7 +35,7 @@ Or when customizing the compression options:
3535

3636
```javascript
3737
import esbuild from "esbuild";
38-
import compressPlugin from "esbuild-plugin-compress";
38+
import compressPlugin from "@liber-ufpe/esbuild-plugin-compress";
3939

4040
const compress = compressPlugin({
4141
gzip: true,

package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
"engines": {
44
"node": ">=18"
55
},
6-
"version": "0.0.2",
6+
"version": "0.0.3",
77
"description": "esbuild plugin to compress output using gzip, brotli, and deflate.",
88
"repository": {
99
"type": "git",

src/index.ts

+3-3
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ import {constants, createBrotliCompress, createDeflate, createGzip} from "node:z
55
import fs from "node:fs";
66
import pipe from "node:stream/promises";
77

8-
interface CompressOptions {
8+
export interface CompressOptions {
99
gzip: boolean;
1010
brotli: boolean;
1111
deflate: boolean;
@@ -53,7 +53,7 @@ const compressBrotli = async (file: string, options: BrotliOptions) => {
5353
);
5454
}
5555

56-
function compressPlugin(options: CompressOptions = defaultOptions): Plugin {
56+
export function compressPlugin(options: CompressOptions = defaultOptions): Plugin {
5757
return {
5858
name: "esbuild-plugin-compress",
5959
setup(build) {
@@ -89,4 +89,4 @@ function compressPlugin(options: CompressOptions = defaultOptions): Plugin {
8989
};
9090
}
9191

92-
module.exports = compressPlugin;
92+
module.exports = {compressPlugin};

0 commit comments

Comments
 (0)