# netjet

> Express middleware to generate preload headers

Latest version **1.4.0** (published 2020-06-12) · MIT license · 0 weekly downloads

## Install

```sh
npm install netjet
pnpm add netjet
yarn add netjet
bun add netjet
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.4.0 |
| Published | 2020-06-12 |
| First published | 2016-01-30 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 6 |
| Unpacked size | 9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 153 |
| Author | Terin Stock |
| Maintainers | terinjokes |
| Keywords | express, middleware, link, preload |

## Links

- npm: https://www.npmjs.com/package/netjet
- Repository: https://github.com/cloudflare/netjet
- Homepage: https://github.com/cloudflare/netjet#readme
- Issues: https://github.com/cloudflare/netjet/issues
- npm.io page: https://npm.io/package/netjet

## Dependencies (6)

- [bl](https://npm.io/package/bl.md) ^1.0.1
- [posthtml](https://npm.io/package/posthtml.md) ^0.9.0
- [lru-cache](https://npm.io/package/lru-cache.md) ^4.0.0
- [hijackresponse](https://npm.io/package/hijackresponse.md) ^2.0.0
- [lodash.defaults](https://npm.io/package/lodash.defaults.md) ^4.0.0
- [lodash.unescape](https://npm.io/package/lodash.unescape.md) ^4.0.0

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 1.4.0 (latest) — 2020-06-12
- 1.3.0 — 2018-02-06
- 1.2.0 — 2018-01-26
- 1.1.4 — 2017-08-14
- 1.1.3 — 2016-08-26
- 1.1.2 — 2016-07-21
- 1.1.1 — 2016-05-30
- 1.1.0 — 2016-02-06
- 1.0.1 — 2016-01-30
- 1.0.0 — 2016-01-30

## README

# netjet [![Travis-CI Status](https://img.shields.io/travis/cloudflare/netjet/master.svg?label=Travis%20CI&style=flat-square)](https://travis-ci.org/cloudflare/netjet)[![](https://img.shields.io/npm/dm/netjet.svg?style=flat-square)](http://browsenpm.org/package/netjet)[![](https://img.shields.io/npm/v/netjet.svg?style=flat-square)](http://browsenpm.org/package/netjet)[![](https://img.shields.io/coveralls/cloudflare/netjet/master.svg?style=flat-square)](https://coveralls.io/github/cloudflare/netjet)[![](https://img.shields.io/badge/stability-experimental-orange.svg?style=flat-square)](https://nodejs.org/api/documentation.html#documentation_stability_index)

netjet is a Node.js HTTP middleware to automatically insert [Preload][preload] link headers in HTML responses.
These Preload link headers allow for web browsers to initiate early resource fetching before being needed for execution.

## Example usage

```javascript
var express = require('express');
var netjet = require('netjet');
var root = '/path/to/static/folder';

express()
  .use(netjet())
  .use(express.static(root))
  .listen(1337);
```

## Options

* **images**, **scripts**, and **styles**: `Boolean`:

  If `true` the corresponding subresources are parsed and added as a Preload Link headers.

* **cache**: `Object`:

  Object passed straight to [`lru-cache`][lru-cache]. It is highly recommended to set `cache.max` to an integer.

* **attributes**: `Array<String>`

  List of custom attributes that should be added to the Preload Link headers.

## License

[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](https://www.tldrlegal.com/l/mit) see `LICENSE.md`.

[preload]: https://www.w3.org/TR/preload/
[posthtml]: https://github.com/posthtml/posthtml#readme
[lru-cache]: https://github.com/isaacs/node-lru-cache#readme

---
_Source: https://npm.io/package/netjet · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._