@adonisjs/bodyparser/build/src/parsers/text.d.ts

BodyParser middleware for AdonisJS http server to read and parse request body

import type { IncomingMessage } from 'node:http';
import { type Encoding, type Options as RawBodyOptions } from 'raw-body';
import { type BodyParserRawConfig } from '../types.ts';
/**
 * Prepares parser options for raw text body parsing by applying defaults
 * for encoding and size limits.
 *
 * @param options - Raw body parser configuration
 */
export declare function prepareTextParserOptions(options: Partial<BodyParserRawConfig>): RawBodyOptions & {
    encoding: Encoding;
};
/**
 * Parses and inflates the raw request body as text. Automatically handles
 * compressed request bodies (gzip, deflate, etc.).
 *
 * @param req - The incoming HTTP request
 * @param options - Parser options including encoding and size limits
 */
export declare function parseText(req: IncomingMessage, options: ReturnType<typeof prepareTextParserOptions>): Promise<string>;