Skip to content

Commit 3b7cc41

Browse files
thlorenzthlorenz
committed
example and documentation
1 parent 2846786 commit 3b7cc41

File tree

2 files changed

+53
-3
lines changed

2 files changed

+53
-3
lines changed

‎README.md‎

Lines changed: 44 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,47 @@
1-
# parse-link-header
2-
[![build status](https://secure.travis-ci.org/thlorenz/parse-link-header.png)](http://travis-ci.org/thlorenz/parse-link-header)
1+
# parse-link-header [![build status](https://secure.travis-ci.org/thlorenz/parse-link-header.png)](http://travis-ci.org/thlorenz/parse-link-header)
32

43
[![testling badge](https://ci.testling.com/thlorenz/parse-link-header.png)](https://ci.testling.com/thlorenz/parse-link-header)
54

6-
Parses a link header and returns paging information for each contained link.
5+
Parses a link header and returns paging information for each contained link.
6+
7+
```js
8+
var parse = require('parse-link-header');
9+
10+
var linkHeader =
11+
'<https://api.github.com/user/9287/repos?page=3&per_page=100>; rel="next", ' +
12+
'<https://api.github.com/user/9287/repos?page=1&per_page=100>; rel="prev"; pet="cat", ' +
13+
'<https://api.github.com/user/9287/repos?page=5&per_page=100>; rel="last"'
14+
15+
var parsed = parse(linkHeader);
16+
console.log(parsed);
17+
```
18+
19+
```js
20+
{ next:
21+
{ page: '3',
22+
per_page: '100',
23+
rel: 'next',
24+
url: 'https://api.github.com/user/9287/repos?page=3&per_page=100' },
25+
prev:
26+
{ page: '1',
27+
per_page: '100',
28+
rel: 'prev',
29+
pet: 'cat',
30+
url: ' https://api.github.com/user/9287/repos?page=1&per_page=100' },
31+
last:
32+
{ page: '5',
33+
per_page: '100',
34+
rel: 'last',
35+
url: ' https://api.github.com/user/9287/repos?page=5&per_page=100' } }
36+
```
37+
38+
## Installation
39+
40+
npm install parse-link-header
41+
42+
## API
43+
44+
***parseLinkHeader(linkHeader : String) : Object***
45+
46+
Parses the given link header containing [web links](http://tools.ietf.org/html/rfc5988) and returns an object keyed by
47+
the `rel` property that contains information about each link.

‎example/parse.js‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
var parse = require('..');
2+
3+
var linkHeader =
4+
'<https://api.github.com/user/9287/repos?page=3&per_page=100>; rel="next", ' +
5+
'<https://api.github.com/user/9287/repos?page=1&per_page=100>; rel="prev"; pet="cat", ' +
6+
'<https://api.github.com/user/9287/repos?page=5&per_page=100>; rel="last"'
7+
8+
var parsed = parse(linkHeader);
9+
console.log(parsed);

0 commit comments

Comments
 (0)