# @andrewsantarin/staticify > Work-in-progress TypeScript support for the latest version of 'staticify': A better static asset handler for Node.js/Express.js Latest version **0.0.3** (published 2020-06-23) · MIT license · 0 weekly downloads ## Install ```sh npm install @andrewsantarin/staticify pnpm add @andrewsantarin/staticify yarn add @andrewsantarin/staticify bun add @andrewsantarin/staticify ``` ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support; pre 1.0. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 0.0.3 | | Published | 2020-06-23 | | First published | 2019-11-28 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | CommonJS | | Node | >=10 | | Dependencies | 3 | | Unpacked size | 18.9 KB | | Known vulnerabilities | 0 (+1 in 1 direct dependencies) | | Install scripts | no | | GitHub stars | 0 | | Author | Rakesh Pai | | Maintainers | andrewsantarin | | Keywords | static, asset, versioning, caching, express, expressjs | ## Links - npm: https://www.npmjs.com/package/@andrewsantarin/staticify - Repository: https://github.com/andrewsantarin/staticify - Homepage: https://github.com/andrewsantarin/staticify#readme - Issues: https://github.com/andrewsantarin/staticify/issues - npm.io page: https://npm.io/package/@andrewsantarin/staticify ## Dependencies (3) - [send](https://npm.io/package/send.md) ^0.17.1 - [memoizee](https://npm.io/package/memoizee.md) ^0.4.14 - [ignore-by-default](https://npm.io/package/ignore-by-default.md) ^2.0.0 ## Recent versions - 0.0.3 (latest) — 2020-06-23 - 0.0.2 — 2020-06-23 - 0.0.1 — 2020-06-23 - 3.3.6 — 2019-11-28 - 3.3.5 — 2019-11-28 ## README # staticify [![NPM version](https://img.shields.io/npm/v/@andrewsantarin/staticify.svg)](https://www.npmjs.com/package/@andrewsantarin/staticify) > ## Fork > > This is a **temporary fork** for work-in-progress TypeScript support for the original [`staticify`](https://www.npmjs.com/package/staticify) library (on [GitHub](https://github.com/andrewsantarin/staticify/tree/feature/typescript-support-wip-npm)). The author of this fork assumes no liability for any damages this fork may cause (see [LICENSE](https://github.com/andrewsantarin/staticify/blob/feature/typescript-support-wip-npm/LICENSE)) and will not provide further support unless it applies to bugs with existing type definition issues. Please refer to the original library for official TypeScript declarations as soon as they are available. > > ## Usage > > ```sh > npm install --save @andrewsantarin/staticify > npm install --save staticify@npm:@andrewsantarin/staticify # If you'd rather use the original name, but point to this library > ``` A better static asset handler for Node.js/Express.js. Provides helpers to add a version identifier to your static asset's public URLs, and to remove the hash before serving the file from the file system. How your URLs are transformed: ``` /home.css --> /home..css ``` For example: ``` /home.css --> /home.ae2b1fca515949e5d54fb22b8ed95575.css /js/script.js --> /js/script.3205c0ded576131ea255ad2bd38b0fb2.js ``` The version hashes are the MD5 of the contents of the static asset. Thus, every file has it's own unique version identifier. When a file changes, only it's own hash changes. This lets you have a far-futures expires header for your static assets without worrying about cache-invalidation, while ensuring that the user only downloads the files that have changed since your last deployment. ## With express.js ```js const path = require('path'); const staticify = require('staticify')(path.join(__dirname, 'public')); // ... app.use(staticify.middleware); app.helpers({getVersionedPath: staticify.getVersionedPath}); ``` And in your template: ```html ``` ### TypeScript staticify ships with official type declarations for TypeScript out of the box. ## Options Options are specified as the second parameter to `staticify`: ```js const staticify = require('staticify')(path.join(__dirname, 'public'), options); ``` ### includeAll Include all files when scanning the public directory. By default, the directories from [ignore-by-default](https://github.com/novemberborn/ignore-by-default/blob/master/index.js) are ignored. * Type: Boolean * Default: `false` ### shortHash Generate a short (7-digit) MD5 hash instead of the full (32-digit) one. * Type: Boolean * Default: `true` ### pathPrefix If you are using the staticify convenience middleware through a specific route, it is necessary to indicate the route in this option. * Type: String * Default: "/" ```js const path = require('path'); const options = { pathPrefix: '/assets' }; const staticify = require('staticify')(path.join(__dirname, 'public'), options); app.use('/assets', staticify.middleware); // `app` is your express instance ``` ### maxAgeNonHashed * Type: String | Number * Default: `0` `maxAge` for assets without a hash such as `/image.png` passed to [send](https://github.com/pillarjs/send). Can be defined as a number of milliseconds or string accepted by [ms](https://www.npmjs.org/package/ms#readme) module (eg. `'5d'`, `'1y'`, etc.) ### sendOptions * Type: Object * Default: `sendOptions: { maxAge: '1y' }` for hashed assets or `maxAge: 0` for non-hashed assets. You can pass any [send](https://github.com/pillarjs/send) options; used in `middleware` and `serve` functions. ## Usage Install from npm: ```sh npm install staticify ``` Initialize the staticify helper with the path of your public directory: ```js const path = require('path'); const staticify = require('staticify')(path.join(__dirname, 'public')); ``` This returns an object with the following helpers: ### .getVersionedPath(path) Does the following transformation to the `path`, and returns immediately: ```js staticify.getVersionedPath('/path/to/file.ext'); // --> /path/to/file..ext ``` This method is meant to be used inside your templates. This method is really fast (simply an in-memory lookup) and returns immediately. When you initialize this module, it crawls your public folder synchronously at startup, and pre-determines all the MD5 hashes for your static files. This slows down application startup slightly, but it keeps the runtime performance at its peak. ### .middleware(req, res, next) Convenience wrapper over `.serve` to handle static files in express.js. ```js app.use(staticify.middleware); // `app` is your express instance ``` ### .replacePaths(string) Takes the input string, and replaces any paths it can understand. For example: ```js staticify.replacePaths('body { background: url("/index.js") }'); ``` returns ```js "body { background: url('/index.d766c4a983224a3696bc4913b9e47305.js') }" ``` Perfect for use in your build script, to modify references to external paths within your CSS files. ### .stripVersion(path) Removes the MD5 identifier in a path. ```js staticify.stripVersion('/path/to/file.ae2b1fca515949e5d54fb22b8ed95575.ext'); // --> /path/to/file.ext ``` Note, this function doesn't verify that the hash is valid. It simply finds what looks like a hash and strips it from the path. ### .refresh() Rebuilds the MD5 version cache described above. Use this method sparingly. This crawls your public folder synchronously (in a blocking fashion) to rebuild the cache. This is typically only useful when you are doing some kind of live-reloading during development. ### .serve(req) Handles an incoming request for the file. Internally calls `.stripVersion` to strip the version identifier, and serves the file with a `maxAge` of one year, using [send](https://github.com/pillarjs/send). Returns a stream that can be `.pipe`d to a http response stream. See [here](https://github.com/pillarjs/send#options) for the options you can pass. ```js staticify.serve(req, { sendOptions: { maxAge: 3600 * 1000 // milliseconds } }).pipe(res); ``` ## License MIT --- _Source: https://npm.io/package/@andrewsantarin/staticify · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._