https://github.com/tusbar/cache-control

Format and parse HTTP Cache-Control header
https://github.com/tusbar/cache-control

cache-control http javascript nodejs

Last synced: 5 days ago
JSON representation

Format and parse HTTP Cache-Control header

• Host: GitHub
• URL: https://github.com/tusbar/cache-control
• Owner: tusbar
• License: mit
• Created: 2018-01-03T17:25:17.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2025-01-06T20:08:00.000Z (18 days ago)
• Last Synced: 2025-01-13T00:08:03.324Z (12 days ago)
• Topics: cache-control, http, javascript, nodejs
• Language: TypeScript
• Homepage:
• Size: 2.28 MB
• Stars: 39
• Watchers: 2
• Forks: 8
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# cache-control

> Format and parse HTTP Cache-Control header

[![npm version](https://badgen.net/npm/v/@tusbar/cache-control)](https://www.npmjs.com/package/@tusbar/cache-control)

[![codecov](https://codecov.io/gh/tusbar/cache-control/graph/badge.svg?token=O8MvGFz46p)](https://codecov.io/gh/tusbar/cache-control)

[![XO code style](https://badgen.net/badge/code%20style/XO/cyan)](https://github.com/xojs/xo)

## CI

[![Tests](https://github.com/tusbar/cache-control/actions/workflows/tests.yml/badge.svg)](https://github.com/tusbar/cache-control/actions/workflows/tests.yml)

[![Release](https://github.com/tusbar/cache-control/actions/workflows/release.yml/badge.svg)](https://github.com/tusbar/cache-control/actions/workflows/release.yml)

## Getting started

```bash

$ npm install @tusbar/cache-control

```

## API

This library exposes a `CacheControl` class and two shortcut methods: `parse()` and `format()`.

### `parse(header)`

```js

const {parse} = require('@tusbar/cache-control')

```

`parse()` takes a `Cache-Control` HTTP header value and returns a `CacheControl` instance.

For example, `parse('max-age=31536000, public')` will return

```js

CacheControl {

  maxAge: 31536000,

  sharedMaxAge: null,

  maxStale: false,

  maxStaleDuration: null,

  minFresh: null,

  immutable: false,

  mustRevalidate: false,

  noCache: false,

  noStore: false,

  noTransform: false,

  onlyIfCached: false,

  private: false,

  proxyRevalidate: false,

  public: true,

  staleIfError: null,

  staleWhileRevalidate: null }

```

### `format(cacheControl)`

```js

const {format} = require('@tusbar/cache-control')

```

`format()` takes a `CacheControl` instance (or similar object) and returns a `Cache-Control` HTTP header value.

For example, `format({maxAge: 31536000, public: true})` will return

```js

max-age=31536000, public

```

## Example usage

```js

res.setHeader('Cache-Control', format({

  public: true,

  immutable: true

}))

```

## FAQ

**Why another cache-control library?**

None of the existing libraries focus on just parsing the `Cache-Control` headers. There are some that expose Express (or connect-like) middlewares, and some unmaintained other ones that do rudimentary parsing of the header. The idea of this module is to parse the header according to the RFC with no further analysis or integration.

## See also

- [`cachecontrol`](https://github.com/pquerna/cachecontrol): Golang HTTP Cache-Control Parser and Interpretation

## License

MIT

## Miscellaneous

```

    ╚⊙ ⊙╝

  ╚═(███)═╝

 ╚═(███)═╝

╚═(███)═╝

 ╚═(███)═╝

  ╚═(███)═╝

   ╚═(███)═╝

```