HTTP Link Header


Parse & format HTTP link headers according to [RFC 8288]

[RFC 8288]: https://tools.ietf.org/html/rfc8288

Install via npm

``sh
$ npm install --save http-link-header
`

Deviations from the RFC

$3

While RFC 8288, Section 3.1 states that relative URI-References
MUST be resolved by the parsers – this library DOES NOT.
This is due to the parser not having an input for the absolute or canonical URI of the related document.
Currently there are no plans to add this, and it is left to the user whether or not to resolve relative URIs.

Usage

`js
var LinkHeader = require( 'http-link-header' )
`

$3

`js
var link = LinkHeader.parse(
'; rel="example"; title="Example Website", ' +
'; rel="alternate"; title="Alternate Example Domain"'
)

> Link {
refs: [
{ uri: 'example.com', rel: 'example', title: 'Example Website' },
{ uri: 'example-01.com', rel: 'alternate', title: 'Alternate Example Domain' },
]
}
`

$3

`js
link.has( 'rel', 'alternate' )
> true
`

$3

`js
link.get( 'rel', 'alternate' )
> [
{ uri: 'example-01.com', rel: 'alternate', title: 'Alternate Example Domain' }
]
`
`js
// Shorthand for rel attributes
link.rel( 'alternate' )
> [
{ uri: 'example-01.com', rel: 'alternate', title: 'Alternate Example Domain' }
]
`

$3

`js
link.set({ uri: 'https://example.com/next', rel: 'next' })
> Link {
refs: [
{ uri: 'example.com', rel: 'example', title: 'Example Website' },
{ uri: 'example-01.com', rel: 'alternate', title: 'Alternate Example Domain' },
{ rel: 'next', uri: 'https://example.com/next' }
]
}
`

$3

`js
link.setUnique({
uri: 'https://example.com/image.png',
rel: 'preload',
as: 'image',
type: 'image/png'
})
> Link {
refs: [
{ uri: 'https://example.com/image.png', rel: 'preload', as: 'image', type: 'image/png' }
]
}

link.setUnique({
uri: 'https://example.com/image.png',
rel: 'preload',
as: 'image',
type: 'image/png'
})
> Link {
refs: [
{ uri: 'https://example.com/image.png', rel: 'preload', as: 'image', type: 'image/png' }
]
}
`

$3

`js
var link = new LinkHeader()

link.parse( '; rel="example"; title="Example Website"' )
> Link {
refs: [
{ uri: 'example.com', rel: 'example', title: 'Example Website' },
]
}

link.parse( '; rel="alternate"; title="Alternate Example Domain"' )
> Link {
refs: [
{ uri: 'example.com', rel: 'example', title: 'Example Website' },
{ uri: 'example-01.com', rel: 'alternate', title: 'Alternate Example Domain' },
]
}

link.parse( '; rel="alternate"; title="Second Alternate Example Domain"' )
> Link {
refs: [
{ uri: 'example.com', rel: 'example', title: 'Example Website' },
{ uri: 'example-01.com', rel: 'alternate', title: 'Alternate Example Domain' },
{ uri: 'example-02.com', rel: 'alternate', title: 'Second Alternate Example Domain' },
]
}
`

$3

`js
link.parse( '; rel=start; title*=UTF-8\'en\'%E2%91%A0%E2%93%AB%E2%85%93%E3%8F%A8%E2%99%B3%F0%9D%84%9E%CE%BB' )
`

`js
> Link {
refs: [
{ uri: '/extended-attr-example', rel: 'start', 'title*': { language: 'en', encoding: null, value: '①⓫⅓㏨♳𝄞λ' } }
]
}
`

$3

`js
link.toString()
> '; rel=example; title="Example Website", ; rel=alternate; title="Alternate Example Domain"'
`

Speed

`
$ npm run benchmark
`

`


http-link-header .parse() ⨉ 1000000

ok ~1.29 s (1 s + 289696759 ns)

http-link-header #toString() ⨉ 1000000

ok ~554 ms (0 s + 553782657 ns)
``