Interface IHttpStringBodyParserOptions

Options for a body parser function, that works with string data.

interface IHttpStringBodyParserOptions {
    encoding?: Nilable<BufferEncoding>;
    limit?: Nilable<number>;
    onLimitReached?: Nilable<HttpRequestHandler>;
    onParsingFailed?: Nilable<ParseErrorHandler>;
}

Hierarchy

Properties

encoding? limit? onLimitReached? onParsingFailed?

Properties

Optional encoding

encoding?: Nilable<BufferEncoding>

The custom string encoding to use.

Default

"utf8"

Optional limit

limit?: Nilable<number>

Defines the maximum size of the body, in bytes. (null) indicates to use NO limit

Optional onLimitReached

onLimitReached?: Nilable<HttpRequestHandler>

A custom handler, to tell the client, that the body is too big.

Optional onParsingFailed

onParsingFailed?: Nilable<ParseErrorHandler>

A custom handler, to tell the client, that the body could not be parsed.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc