npm.io
1.0.0 • Published 9 years ago

parse-prefer-header

Licence
MIT
Version
1.0.0
Deps
1
Vulns
0
Weekly
0
Stars
2

node-parse-prefer-header

Parses an HTTP Prefer header, aka RFC7240.

const parsePreferHeader = require('parse-prefer-header');

const preferences = parsePreferHeader('respond-async, wait=300');
// preferences = { respondAsync: true, wait: '300' }

Installation

$ npm install parse-prefer-header

Features

  • Parses the HTTP Prefer header into a friendly JavaScript object
  • Normalizes tokens into JavaScript properties (e.g. respondAsync)
  • Handles quoting correctly (e.g. foo=";= ,;=" becomes { foo: ';= ,;='})
  • Supports token parameters

API

parsePreferHeader(preferHeader: string | string[]): { [key: string]: string | boolean }

Parses the Prefer header value, or an Array of such values, and returns an object mapping each preference token to its value or true.

See here for an explanation of the initial set of preferences.

Keywords