format-link-header

format-link-header

Allows to format a given links ref object, to the format as described in RFC 5988. Precisely it achieves the exactly inverse process performed by the parse-link-header.

Installation

  npm install --save format-link-header

Usage

1. Given a links refs object generated by parse-link-header:

  const link = { next:
     { page: '3',
       per_page: '100',
       rel: 'next',
       url: 'https://api.github.com/user/9287/repos?page=3&per_page=100' },
    prev:
     { page: '1',
       per_page: '100',
       rel: 'prev',
       pet: 'cat',
       url: 'https://api.github.com/user/9287/repos?page=1&per_page=100' },
    last:
     { page: '5',
       per_page: '100',
       rel: 'last',
       url: 'https://api.github.com/user/9287/repos?page=5&per_page=100' } }

1. Format the link header

  const formatter = require('format-link-header');
  formatter(link);

1. Web link headers generated!

  <https://api.github.com/user/9287/repos?page=3&per_page=100>; rel="next", <https://api.github.com/user/9287/repos?page=1&per_page=100>; rel="prev"; pet="cat", <https://api.github.com/user/9287/repos?page=5&per_page=100>; rel="last"

Changelog

2.0.0

• Updated code to ES6
• All devDependencies updates
• Removed support for node 0.10 and 0.12
• Added support for node 4 and node 6