Skip to content
Effect 4.0 is here. One ecosystem. Zero dependencies.

Headers

18 exports Since v1.0.0 Source

Combinators

Since v1.0.0

Signature

declare const get: {
(key: string): (self: Headers) => Option<string>;
(self: Headers, key: string): Option<string>;
}
Since v1.0.0

Signature

declare const has: {
(key: string): (self: Headers) => boolean;
(self: Headers, key: string): boolean;
}
Since v1.0.0

Signature

declare const merge: {
(headers: Headers): (self: Headers) => Headers;
(self: Headers, headers: Headers): Headers;
}
Since v1.0.0

Signature

declare const redact: {
(key: string | RegExp | readonly Array<string | RegExp>): (self: Headers) => Record<string, string | Redacted.Redacted>;
(self: Headers, key: string | RegExp | readonly Array<string | RegExp>): Record<string, string | Redacted.Redacted>;
}
Since v1.0.0

Signature

declare const remove: {
(key: string | RegExp | readonly Array<string | RegExp>): (self: Headers) => Headers;
(self: Headers, key: string | RegExp | readonly Array<string | RegExp>): Headers;
}
Since v1.0.0

Signature

declare const set: {
(key: string, value: string): (self: Headers) => Headers;
(self: Headers, key: string, value: string): Headers;
}
Since v1.0.0

Signature

declare const setAll: {
(headers: Input): (self: Headers) => Headers;
(self: Headers, headers: Input): Headers;
}

Constructors

Since v1.0.0

Signature

declare const empty: Headers

Signature

declare const fromInput: (input?: Input) => Headers

Signature

declare function unsafeFromRecord(input: Record.ReadonlyRecord<string, string>): Headers

Fiber Refs

Signature

declare const currentRedactedNames: FiberRef.FiberRef<ReadonlyArray<string | RegExp>>

Models

Headers

interface
Since v1.0.0

Signature

interface Headers extends unknown {
[key: string]: string;
readonly [HeadersTypeId]: typeof HeadersTypeId;
}

Input

type
Since v1.0.0

Signature

type Input = Record.ReadonlyRecord<string, string | ReadonlyArray<string> | undefined> | Iterable<readonly [string, string]>

Refinements

Signature

declare function isHeaders(u: unknown): u is Headers

Schemas

Since v1.0.0

Signature

declare const schema: Schema.Schema<Headers, Record.ReadonlyRecord<string, string>>

Signature

declare const schemaFromSelf: Schema.Schema<Headers>

Type Ids

Signature

declare const HeadersTypeId: unique symbol
Since v1.0.0

Signature

type HeadersTypeId = typeof HeadersTypeId