[](https://github.com/arthurfiorette/tinylibs/issues)
[](https://github.com/arthurfiorette/tinylibs/stargazers)
[](https://github.com/arthurfiorette/tinylibs/blob/main/LICENSE)
[](https://codecov.io/gh/arthurfiorette/tinylibs)
[](https://app.fossa.com/projects/git%2Bgithub.com%2Farthurfiorette%2Ftinylibs?ref=badge_shield)
[](https://gitter.im/tinylibs-js-org/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[](https://twitter.com/acdlite/status/974390255393505280)
[](https://www.npmjs.com/package/cache-parser)
[](https://www.npmjs.com/package/cache-parser)
[](https://www.jsdelivr.com/package/npm/cache-parser)
[](https://bundlephobia.com/package/cache-parser@latest)
[](https://packagephobia.com/result?p=cache-parser@latest)
Cache Parser is a minimal parser for the Cache-Control header.
## Table of Contents
- [Table of Contents](#table-of-contents)
- [Installing](#installing)
- [Node](#node)
- [Browser](#browser)
- [Url Import](#url-import)
- [Getting Started](#getting-started)
- [Usage](#usage)
- [License](#license)
## Installing
### Node
```sh
npm install cache-parser # or yarn add cache-parser
```
```js
const { parse, tokenize } = require('cache-parser');
import { parse, tokenize } from 'cache-parser';
```
### Browser
```html
```
```js
const { parse, tokenize } = window.cacheParser;
```
### Url Import
```ts
import { parse, tokenize } from 'https://cdn.skypack.dev/cache-parser@latest';
```
## Getting Started
This package is a parser and builder for all Cache-Control directives. You can parse a
string with [`parse()`](./src/parse.ts) and build a http ready header with
[`tokenize()`](./src/tokenize.ts).
All needed documentation is available in form of `TSDoc` comments.
### Usage
```ts
import { parse, CacheControl } from 'cache-parser';
const rawHeader = 'public, max-age=3600';
const {
public, // true
maxAge, // 3600
immutable // undefined
} = parse(rawHeader);
const cacheProperties: CacheControl = { public: true, maxAge: 3600 };
// ['public', 'max-age=3600']
const cacheTokens = tokenize(cacheProperties);
// 'public, max-age=3600'
const httpHeader = tokens.join(', ');
```
## License
Licensed under the **MIT**. See [`LICENSE`](LICENSE) for more informations.
[](https://app.fossa.com/projects/git%2Bgithub.com%2Farthurfiorette%2Ftinylibs?ref=badge_small)