Parses a link header and returns paging information for each contained link.
var parse = require('parse-link-header');
var linkHeader =
'<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"'
var parsed = parse(linkHeader);
console.log(parsed);
{ 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' } }
npm install parse-link-header
parseLinkHeader(linkHeader : String) : Object
Parses the given link header containing web links and returns an object keyed by
the rel
property that contains information about each link.
The purpose of this module is to parse the link header information. To format an object generated by this module back to the link header string, use the format-link-header module.