ui-build-compression

1.1.4 verified Mon Apr 27 auth: no javascript

A Rust-powered build compression tool that creates gzip, brotli, zstd, and deflate compressed file variants alongside originals for production UI deployments. Version 1.1.4 ships TypeScript definitions and supports both programmatic (Rust and Node.js) and CLI usage. Key differentiator: aggressively configured compression settings in Rust for maximum reduction, outperforming pure-JS compressors particularly for brotli and zstd. Suitable for build pipelines of static sites or SPAs.

Common errors

error Error: Cannot find module 'ui-build-compression' ↓

cause Package not installed or missing from node_modules.

fix

Run 'npm install ui-build-compression' or 'yarn add ui-build-compression'.

error TypeError: compress is not a function ↓

cause Default import used instead of named import.

fix

Use named import: import { compress } from 'ui-build-compression'

error Error: ENOENT: no such file or directory, stat '/path/to/my/directory' ↓

cause Provided path does not exist or is relative from wrong working directory.

fix

Provide an absolute path or ensure relative path is correct from process.cwd().

Warnings

gotcha The compress function is asynchronous and returns a Promise; omitting await or .catch() can lead to unhandled promise rejections. ↓

fix Always use await or attach .catch() to handle errors.

gotcha The package compresses all files in the directory recursively. Large directories may take significant time due to aggressive compression settings. ↓

fix Consider using a smaller subdirectory or exclude large binary files if needed. No built-in filter yet.

gotcha The CLI command 'ui-build-compression' may conflict if a global package with the same name is installed. Always use npx or local scripts. ↓

fix Prefix with npx: npx ui-build-compression /path/to/dir

Install

npm install ui-build-compression

yarn add ui-build-compression

pnpm add ui-build-compression

Imports

compress
wrong
```
import compress from 'ui-build-compression'
```
correct
```
import { compress } from 'ui-build-compression'
```
The package exports a named export, not a default export. Also works with require('ui-build-compression').compress.

compress

wrong

const compress = require('ui-build-compression')

correct

const { compress } = require('ui-build-compression')

CommonJS require returns an object; destructure to get the named export.

compress
```
import { compress } from 'ui-build-compression'
```
TypeScript usage: same named import. Package includes type definitions.

Quickstart

Compresses all static files in the given directory using gzip, brotli, zstd, and deflate, generating .gz, .br, .zst, .zz alongside originals.

import { compress } from 'ui-build-compression';
import path from 'path';

const buildDir = path.resolve('./dist');
compress(buildDir).then(() => {
  console.log('Compression complete!');
}).catch(err => {
  console.error('Compression failed:', err);
});