Skip to content

HeadersParser

Low-level parser for multipart header blocks.

6 exports Added in v4.0.0 Source

Constructors

make

Added in v4.0.0 Source

Creates an incremental multipart header parser.

Signature

declare const make: () => (chunk: Uint8Array, start: number) => ReturnValue;

Errors

Failure interface

Added in v4.0.0 Source

A multipart header parsing failure.

Signature

interface Failure {
  readonly _tag: "Failure";
  readonly headers: Record<string, string | Array<string>>;
  readonly reason: FailureReason;
}

FailureReason type

Added in v4.0.0 Source

The reason a multipart header block could not be parsed.

Signature

type FailureReason =
  | "TooManyHeaders"
  | "HeaderTooLarge"
  | "InvalidHeaderName"
  | "InvalidHeaderValue";

Models

Continue interface

Added in v4.0.0 Source

Indicates that the parser needs more input.

Signature

interface Continue {
  readonly _tag: "Continue";
}

Headers interface

Added in v4.0.0 Source

A successfully parsed multipart header block.

Signature

interface Headers {
  readonly _tag: "Headers";
  readonly endPosition: number;
  readonly headers: Record<string, string | Array<string>>;
}

ReturnValue type

Added in v4.0.0 Source

The result of parsing a multipart header block.

Signature

type ReturnValue = Continue | Failure | Headers;