Skip to main content

A module to handle HTTP header `Link` according to RFC 8288 standard.

Works with
This package works with Bun
This package works with Cloudflare Workers
This package works with Node.js
This package works with Deno
It is unknown whether this package works with Browsers
JSR Score
100%
Published
2 weeks ago

HTTP Header Link (ES)

⚖ī¸ MIT

GitHub: hugoalh-studio/http-header-link-es JSR: @hugoalh/http-header-link NPM: @hugoalh/http-header-link

An ES (JavaScript & TypeScript) module to handle the HTTP header Link according to the specification RFC 8288.

🔰 Begin

đŸŽ¯ Targets

Registry - JSR Registry - NPM Remote Import
Bun >= v1.1.0 ✔ī¸ node_modules ✔ī¸ Specifier npm: ❌
Cloudflare Workers ✔ī¸ node_modules ✔ī¸ node_modules ❌
Deno >= v1.42.0 ✔ī¸ Specifier jsr: ✔ī¸ Specifier npm: ✔ī¸
NodeJS >= v16.13.0 ✔ī¸ node_modules ✔ī¸ node_modules ❌

ℹī¸ Note

It is possible to use this module in other methods/ways which not listed in here, however it is not officially supported.

#ī¸âƒŖ Registries Identifier

  • JSR:
    @hugoalh/http-header-link
    
  • NPM:
    @hugoalh/http-header-link
    

ℹī¸ Note

  • Although it is recommended to import the entire module, it is also able to import part of the module with sub path if available, please visit file jsr.jsonc property exports for available sub paths.
  • It is recommended to use this module with tag for immutability.

#ī¸âƒŖ Remote Import Paths

  • GitHub Raw: (Require Tag)
    https://raw.githubusercontent.com/hugoalh-studio/http-header-link-es/${Tag}/mod.ts
    

ℹī¸ Note

  • Although it is recommended to import the entire module with the main path mod.ts, it is also able to import part of the module with sub path if available, but do not import if:

    • it's file path has an underscore prefix (e.g.: _foo.ts, _util/bar.ts), or
    • it is a benchmark or test file (e.g.: foo.bench.ts, foo.test.ts), or
    • it's symbol has an underscore prefix (e.g.: export function _baz() {}).

    These elements are not considered part of the public API, thus no stability is guaranteed for them.

  • Although there have 3rd party services which provide enhanced, equal, or similar methods/ways to remote import the module, beware these services maybe inject unrelated elements and thus affect the security.

🛡ī¸ Permissions

This module does not require any permission.

🧩 APIs

  • class HTTPHeaderLink {
      constructor(input?: string | Headers | HTTPHeaderLink | HTTPHeaderLinkEntry[] | Response): this;
      add(input: string | Headers | HTTPHeaderLink | HTTPHeaderLinkEntry[] | Response): this;
      entries(): HTTPHeaderLinkEntry[];
      getByParameter(key: string, value: string): HTTPHeaderLinkEntry[];
      getByRel(value: string): HTTPHeaderLinkEntry[];
      hasParameter(key: string, value: string): boolean;
      toString(): string;
      static parse(input: string | Headers | HTTPHeaderLink | Response): HTTPHeaderLink;
      static stringify(input: HTTPHeaderLinkEntry[]): string;
    }
    
  • type HTTPHeaderLinkEntry = [
      uri: string,
      parameters: { [key: string]: string; }
    ];
    

ℹī¸ Note

For the prettier documentation, can visit via:

✍ī¸ Examples

  • new HTTPHeaderLink(`<https://example.com>; rel="preconnect"`);
    /*=>
    HTTPHeaderLink [
      ["https://example.com", { rel: "preconnect" }]
    ]
    */
    
  • new HTTPHeaderLink(`<https://example.com/%E8%8B%97%E6%9D%A1>; rel="preconnect"`);
    /*=>
    HTTPHeaderLink [
      ["https://example.com/č‹—æĄ", { rel: "preconnect" }]
    ]
    */
    
Built and signed on
GitHub Actions
View transparency log

Add Package

deno add @hugoalh/http-header-link

Import symbol

import * as mod from "@hugoalh/http-header-link";

Add Package

npx jsr add @hugoalh/http-header-link

Import symbol

import * as mod from "@hugoalh/http-header-link";

Add Package

yarn dlx jsr add @hugoalh/http-header-link

Import symbol

import * as mod from "@hugoalh/http-header-link";

Add Package

pnpm dlx jsr add @hugoalh/http-header-link

Import symbol

import * as mod from "@hugoalh/http-header-link";

Add Package

bunx jsr add @hugoalh/http-header-link

Import symbol

import * as mod from "@hugoalh/http-header-link";