express-stream-compressed-static

An expressjs middleware, to compress and stream static files. Support brotli and gzip compression (if brotli is enabled, and user's browser also support, brotli use be used)

Table of contents:

1. Usage example
2. Installation
3. Usage Details
4. License (MIT)
5. [Changelog][5-changelog]
6. Question and Feedback

1. Usage example

1// import using require
2const serveStatic = require("express-stream-compressed-static")
3
4// import in ES6
5import serveStatic from "express-stream-compressed-static";
6import path from "path"
7
8
9// ... your express app
10// const app = Express();
11
12// Should be the first
13app.use("/static", serveStatic(path.join(__dirname, "../path-to-static-dir")))
14
15// Or with options
16app.use("/static", serveStatic(path.join(__dirname, "../path-to-static-dir"), {
17    enableBrotli: boolean,
18    cacheControl: {
19        maxAge: numbe,
20        noTransform: boolean,
21        public: boolean,
22        additionalValue: string
23    }
24}))
25

2. Installation

express-stream-compressed-static is available on npmjs, and can be install via npm or yarn as following (without $ ofcourse):

1# with npm
2$ npm i express-stream-compressed-static --save
3
4# with yarn
5$ yarn add express-stream-compressed-static

3. Usage Details

serveStatic(path: string, options: StaticHandlerOptions) => Function: Get the middleware handler to compress and stream static files

• path: path to the static directory
• options: see StaticHandlerOptions below

type StaticHandlerOptions

• enableBrotli {boolean}: enable brotli compress when client's browser supported. true by default.
• cacheControl {StaticHandlerCacheOptions | optional}: cache control options
• cacheCompressedFiles {boolean | StaticHandlerCacheCompressedFilesOptions}: cache compressed files to avoid re-compress files

type StaticHandlerCacheOptions

• maxAge {number}: add max-age to cache control options (in seconds)
• noTransform {boolean}: add no-transform to cache control options
• public {boolean}: add public to cache control options
• additionalValue {string}: add this value to cache control options *For example, when maxAge, noTransform and public is set, result will be Cache-Control: max-age=xxxx, no-transform, public

type StaticHandlerCacheCompressedFilesOptions

• savePath {string}: specify where the cache files will be stored. Otherwise, it will store file in same directory as the original file
• excludeQueryString {boolean}: save compressed file name without queryString (false by default). For example, your file url is path/bundle.js?v=0.0.1 and using brotli compression, when the value to true, the filename will be save-path/bundle.js.br. Otherwise, the filename will be save-path/bundle.js?v=0.0.1.br

4. License

MIT

5. Changelog

• [0.0.2] added options.cacheCompressedFiles
• [0.0.1] publish inital version

6. Question and Feedback

Feel free to start a thread for question, or feedback.