@arcjet/headers

@arcjet/headers

Arcjet extension of the Headers class.

• npm package (@arcjet/headers)
• GitHub source code (headers/ in arcjet/arcjet-js)

What is this?

This is an internal utility to help us deal with Headers. This exists to prevent the cookie header from being set and non-string values from being set.

When should I use this?

You should not use this but use Headers or plain objects instead. This package matches our current needs which are likely different from yours.

Install

This package is ESM only. Install with npm in Node.js:

npm install @arcjet/headers

Use

import { ArcjetHeaders } from "@arcjet/headers";

const headers = new ArcjetHeaders({ abc: "123" });

console.log(headers.get("abc")); // => "123"

API

This package exports the identifier ArcjetHeaders. The default export is ArcjetHeaders.

This package exports no TypeScript types.

new ArcjetHeaders([init])

Creates a new ArcjetHeaders instance. We use this internally to prevent the cookie header from being set and to ensure only string values are used.

Parameters

• init (Headers | Array<[string, string]> | Record<string, Array<string> | string | undefined>, optional) — initial headers to set

Returns

An ArcjetHeaders instance that extends the standard Headers class.

License

Apache License, Version 2.0 © Arcjet Labs, Inc.