npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@windyroad/link-header

v1.0.1

Published

Parse & format HTTP link headers according to RFC 8288

Downloads

26

Readme

@windyroad/link-header

Parse & format HTTP link headers according to RFC 8288, based on the awesome HTTP Link Header library.

A huge shout-out goes to the team behind the HTTP Link Header library. The comprehensive implementation and set of tests, made porting it to Typescript a breeze.

Why?

I needed something that worked in the browser and the HTTP Link Header library's support for node.js Buffer's prevent that.

Installation

You can install @windyroad/link-header using npm:

npm install @windyroad/link-header

Usage

Parsing a Link Header

To parse a link header string, you can use the parseLinkHeader function:

import { parseLinkHeader } from '@windyroad/link-header';

const linkHeader = '<https://api.example.com/users?page=2>; rel="next", <https://api.example.com/users?page=5>; rel="last"';
const links = parse(linkHeader);

console.log(links);

This will output:

[
  {
    uri: 'https://api.example.com/users?page=2',
    rel: 'next'
  },
  {
    uri: 'https://api.example.com/users?page=5',
    rel: 'last'
  }
]

this is equivalent to

import { LinkHeader } from '@windyroad/link-header';

const linkHeader = '<https://api.example.com/users?page=2>; rel="next", <https://api.example.com/users?page=5>; rel="last"';
const links = new LinkHeader(linkHeader);

console.log(links);

Manipulating a Link Header

To manipulate a link header, you can use the LinkHeader class:

import { LinkHeader } from '@windyroad/link-header';

const linkHeaderString = '<https://api.example.com/users?page=2>; rel="next", <https://api.example.com/users?page=5>; rel="last"';
const linkHeader = LinkHeader.parse(linkHeaderString);

// Find the link with rel="next" and change its URI.
const nextLink = linkHeader.rel('next');
nextLink.uri = 'https://api.example.com/users?page=3';

// Add a new link with rel="prev".
linkHeader.set({ uri: 'https://api.example.com/users?page=1', rel: 'prev' }));

const newLinkHeaderString = linkHeader.toString();

console.log(newLinkHeaderString);

This will output:

<https://api.example.com/users?page=3>; rel="next", <https://api.example.com/users?page=1>; rel="prev"

API

parse(linkHeader: string): LinkHeader

Parses a link header string into an array of LinkHeader object.

Contributing

Contributions are welcome! Please read the contributing guidelines for more information.

License

@windyroad/link-header is lovingly licensed under the MIT License. ❤️