Skip to content

Http2FrameCodecOptions

Http2FrameCodecOptions = object

Defined in: packages/format-http/src/h2/http2-frame.ts:98

Options for Http2FrameCodec.

readonly headerTableSize: number

Defined in: packages/format-http/src/h2/http2-frame.ts:128

This endpoint’s SETTINGS_HEADER_TABLE_SIZE, for the HPACK decoder.


readonly optional huffman?: boolean

Defined in: packages/format-http/src/h2/http2-frame.ts:131

Huffman-code outgoing strings. Defaults to true.


readonly maxFieldBlockSize: number

Defined in: packages/format-http/src/h2/http2-frame.ts:125

Largest encoded field block (HEADERS plus CONTINUATIONs) buffered for decoding; a larger one is a connection error (ENHANCE_YOUR_CALM). Above maxHeaderListSize, it leaves room to decode a list over that limit and answer it as a stream error rather than closing the connection.


readonly maxFrameSize: number

Defined in: packages/format-http/src/h2/http2-frame.ts:110

This endpoint’s SETTINGS_MAX_FRAME_SIZE: a larger frame is a connection error.


readonly maxHeaderListSize: number

Defined in: packages/format-http/src/h2/http2-frame.ts:117

This endpoint’s SETTINGS_MAX_HEADER_LIST_SIZE: a larger decoded list is a stream error, reported once the whole block was decoded so that HPACK state stays in sync.


readonly role: "client" | "server"

Defined in: packages/format-http/src/h2/http2-frame.ts:104

server expects the client preface before the first frame; client expects frames straight away. Neither sends the preface: the client’s connection writes HTTP2_CLIENT_PREFACE itself.