cache-parser

  
run🏃
Cache Parser
  

Cache Parser is a minimal parser for the Cache-Control header.

Table of Contents

• Table of Contents
• Installing
  • Node
  • Browser
  • Url Import
• Getting Started
  • Usage
• License

Installing

Node

npm install --save cache-parser
# or
yarn add cache-parser

const { parse, tokenize } = require('cache-parser');
import { parse, tokenize } from 'cache-parser';

Browser

<script
  crossorigin
  src="https://cdn.jsdelivr.net/npm/cache-parser@latest/dist/index.js"
></script>

const { parse, tokenize } = window.cacheParser;

Url Import

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() and build a http ready header with tokenize().

All needed documentation is available in form of TSDoc comments.

Usage

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 for more informations.