https://github.com/vajahath/brotlin
A handy CLI/API for compressing files to Brotli format.
https://github.com/vajahath/brotlin
brotli brotli-compression browser gzip node-js npm-package performance web-application
Last synced: 8 months ago
JSON representation
A handy CLI/API for compressing files to Brotli format.
- Host: GitHub
- URL: https://github.com/vajahath/brotlin
- Owner: vajahath
- License: mit
- Created: 2020-02-22T18:39:14.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-05T08:01:39.000Z (almost 3 years ago)
- Last Synced: 2025-01-19T01:41:49.029Z (10 months ago)
- Topics: brotli, brotli-compression, browser, gzip, node-js, npm-package, performance, web-application
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/brotlin
- Size: 1.59 MB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
> :tanabata_tree: Brotlin 2 public release planned on 2020 April end.
# brotlin 2 (Preview)
A handy CLI/API for [Brotli](https://github.com/google/brotli) compression. Helps you to convert files to Brotli(`.br`) format.
## Install
Requires Node >=10.
From npm,
```sh
npm i -g brotlin
```
From [Github Package Registry](https://github.com/vajahath/brotlin/packages). ([Guide](https://help.github.com/en/github/managing-packages-with-github-packages/configuring-npm-for-use-with-github-packages)).
Type definitions are bundled with this package.
## Usage
### Quick start
```bash
# cd to your dir
cd my-dir
# all files matching * glob pattern
brotlin compress "*"
# same as above (all files matching *)
brotlin compress
# single file
brotlin compress index.html
# decompress
brotlin decompress index.html.br
# you've options (--help for more)
brotlin compress style.css --quality 8 # default is 11
```
A new compressed file ending with `.br` will be created for every file feeding in to the CLI.
You can pass in a relative path or an absolute path or a glob pattern.
### `--help` for help
```bash
$ brotlin --help
Usage: brotlin [options] [command]
Options:
-V, --version output the version number
-h, --help output usage information
Commands:
compress [options] [file] Creates a compressed file in the same location. Argument can be
relative/absolute/glob paths [default:*]. Check
https://www.npmjs.com/package/brotli to know more about the
following options
decompress [options] [file] Creates a decompressed file in the same location. Argument can be
relative/absolute/glob paths [default:*]. Check
https://www.npmjs.com/package/brotli to know more about the
following options
```
`--help` for `brotlin compress` command:
```bash
$ brotlin compress --help
Usage: brotlin compress [options] [file]
Creates a compressed file in the same location. Argument can be relative/absolute/glob paths [default:*]. Check https://www.npmjs.com/package/brotli to know more about the following options
Options:
-m, --mode Brotli compression mode (0 = generic[default], 1 = text, 2 = font (WOFF2))
-q, --quality Compression quality [0 - 11]. [default: 11]
-w, --window Compression window size [default: 22]
-p, --parallel Processes number of files in parallel. [default: 1]
-h, --help output usage information
```
For decompress, see `brotlin decompress --help`
### One more example
```bash
# compress all fils in the dist folder
cd dist # moved to dist
brotlin compress **/* # compress all files in the directory
```
## APIs [](https://www.typescriptlang.org/)
Just incase you need it.
```ts
import { compression, decompression } from 'brotlin';
// or
const { compression, decompression } = require('brotlin');
compression({
path: '*.html', // required
parallelJobCount: 1, // optional
mode: 0, // optional
quality: 11, // optional
windowSize: 22 // optional
}).then(files => console.log(`Compressed ${files.length} files`));
decompression({
path: '*.html.br', // required
parallelJobCount: 1 // optional
}).then(files => console.log(`Decompressed ${files.length} files`));
```
### Having issues with compression?
This module uses the [npm/brotli](https://www.npmjs.com/package/brotli) module. Hence check the reported [issues](https://github.com/foliojs/brotli.js/issues) also.
[](https://github.com/vajahath/generator-ts-np)
## Licence
MIT © [Vajahath Ahmed](https://twitter.com/vajahath7)