Skip to content

Headers

18 exports Added in v1.0.0 Source

Combinators

get

Added in v1.0.0 Source

Signature

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

has

Added in v1.0.0 Source

Signature

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

merge

Added in v1.0.0 Source

Signature

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

redact

Added in v1.0.0 Source

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>;
}

remove

Added in v1.0.0 Source

Signature

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

set

Added in v1.0.0 Source

Signature

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

setAll

Added in v1.0.0 Source

Signature

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

Constructors

empty

Added in v1.0.0 Source

Signature

declare const empty: Headers;

fromInput

Added in v1.0.0 Source

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

Added in v1.0.0 Source

Signature

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

Input type

Added in v1.0.0 Source

Signature

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

Refinements

isHeaders

Added in v1.0.0 Source

Signature

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

Schemas

schema

Added in v1.0.0 Source

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;

HeadersTypeId type

Added in v1.0.0 Source

Signature

type HeadersTypeId = typeof HeadersTypeId;