Skip to main content
Home
Browse packagesDocsSign in

@hugoalh/http-header-link@1.0.3
Built and signed on GitHub Actions

latest
hugoalh/http-header-link-es

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

This package works with DenoIt is unknown whether this package works with Cloudflare Workers, Node.js, Bun
It is unknown whether this package works with Cloudflare Workers
It is unknown whether this package works with Node.js
This package works with Deno
It is unknown whether this package works with Bun
JSR Score
100%
Published
6 months ago (1.0.3)

HTTP Header Link (ES)

⚖️ MIT

GitHub: hugoalh/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

Remote JSR NPM
Bun >= v1.1.0 ❌ ❓ ✔️
Cloudflare Workers ❌ ❓ ✔️
Deno >= v1.42.0 ✔️ ✔️ ✔️
NodeJS >= v16.13.0 ❌ ❓ ✔️
Note

  • It is possible to use this module in other methods/ways which not listed in here, however those methods/ways are not officially supported, and should beware maybe cause security issues.

#️⃣ Resources Identifier

  • Remote - GitHub Raw: 
    https://raw.githubusercontent.com/hugoalh/http-header-link-es/{Tag}/mod.ts
  • JSR: 
    [jsr:]@hugoalh/http-header-link[@{Tag}]
  • NPM: 
    [npm:]@hugoalh/http-header-link[@{Tag}]
Note

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

    • it's 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.: _bar, _foo).

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

  • For usage of JSR or NPM resources, it is recommended to import the entire module with the main entrypoint, however it is also able to import part of the module with sub entrypoint if available, please visit the file jsr.jsonc property exports for available sub entrypoints.

  • It is recommended to use this module with tag for immutability.

🛡️ Require Runtime Permissions

This module does not require any runtime permission.

🧩 APIs

  • class HTTPHeaderLink {
  constructor(...inputs: (string | Headers | HTTPHeaderLink | HTTPHeaderLinkEntry[] | Response)[]);
  add(...inputs: (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(...inputs: (string | Headers | HTTPHeaderLink | HTTPHeaderLinkEntry[] | Response)[]): HTTPHeaderLink;
  static stringify(...inputs: (string | Headers | HTTPHeaderLink | HTTPHeaderLinkEntry[] | Response)[]): string;
}

  • type HTTPHeaderLinkEntry = [
  uri: string,
  parameters: { [key: string]: string; }
];
Note

✍️ 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

New Ticket: Report package

Please provide a reason for reporting this package. We will review your report and take appropriate action.

Please review the JSR usage policy before submitting a report.

Add Package

deno add jsr:@hugoalh/http-header-link

Import symbol

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

Import directly with a jsr specifier

import * as http_header_link from "jsr:@hugoalh/http-header-link";

Add Package

pnpm i jsr:@hugoalh/http-header-link
or (using pnpm 10.8 or older)
pnpm dlx jsr add @hugoalh/http-header-link

Import symbol

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

Add Package

yarn add jsr:@hugoalh/http-header-link
or (using Yarn 4.8 or older)
yarn dlx jsr add @hugoalh/http-header-link

Import symbol

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

Add Package

npx jsr add @hugoalh/http-header-link

Import symbol

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

Add Package

bunx jsr add @hugoalh/http-header-link

Import symbol

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