@types/parse-link-header

What is @types/parse-link-header?

@types/parse-link-header provides TypeScript type definitions for the parse-link-header package, which is used to parse HTTP link headers for pagination and other purposes.

What are @types/parse-link-header's main functionalities?

Parsing Link Headers

This feature allows you to parse an HTTP link header string into a JavaScript object. The example demonstrates parsing a GitHub API link header.

const parseLinkHeader = require('parse-link-header');
const linkHeader = '<https://api.github.com/user/repos?page=3&per_page=100>; rel="next", <https://api.github.com/user/repos?page=1&per_page=100>; rel="prev"';
const parsed = parseLinkHeader(linkHeader);
console.log(parsed);

Accessing Pagination Links

This feature allows you to access specific pagination links (e.g., next, prev) from the parsed link header object. The example shows how to access the URLs for the next and previous pages.

const parseLinkHeader = require('parse-link-header');
const linkHeader = '<https://api.github.com/user/repos?page=3&per_page=100>; rel="next", <https://api.github.com/user/repos?page=1&per_page=100>; rel="prev"';
const parsed = parseLinkHeader(linkHeader);
if (parsed.next) {
  console.log('Next page URL:', parsed.next.url);
}
if (parsed.prev) {
  console.log('Previous page URL:', parsed.prev.url);
}

Other packages similar to @types/parse-link-header

http-link-header

The http-link-header package provides similar functionality for parsing HTTP link headers. It offers a more comprehensive API for working with link headers, including methods for adding, removing, and serializing links. Compared to @types/parse-link-header, it provides more advanced manipulation capabilities.

link-header-parser

The link-header-parser package is another alternative for parsing HTTP link headers. It focuses on simplicity and ease of use, providing a straightforward API for parsing and accessing link relations. It is similar to @types/parse-link-header in terms of basic parsing functionality but may lack some of the advanced features of other packages.

README

Installation

npm install --save @types/parse-link-header

Summary

This package contains type definitions for parse-link-header (https://github.com/thlorenz/parse-link-header).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/parse-link-header.

index.d.ts

// Type definitions for parse-link-header 1.0
// Project: https://github.com/thlorenz/parse-link-header
// Definitions by: Nick Zelei <https://github.com/nickzelei>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped

declare namespace parseLinkHeader {
    interface Link {
        url: string;
        rel: string;
        [queryParam: string]: string;
    }

    interface Links {
        [rel: string]: Link;
    }
}

declare function parseLinkHeader(linkHeader: string | null | undefined): parseLinkHeader.Links | null;
export = parseLinkHeader;

Additional Details

• Last updated: Tue, 16 Nov 2021 18:31:31 GMT
• Dependencies: none
• Global values: none

Credits

These definitions were written by Nick Zelei.