oak.BodyOptions | /src/service/deps.ts | hex@0.5.15

interface oak.BodyOptions

import { type oak } from "https://deno.land/x/hex@0.5.15/src/service/deps.ts";
const { BodyOptions } = oak;

Options which can be used when accessing the .body() of a request.

Type Parameters

optional

T extends BodyType = BodyType

the BodyType to attempt to use when decoding the request body.

Properties

optional

limit: number

When reading a non-streaming body, set a limit whereby if the content length is greater then the limit or not set, reading the body will throw.

This is to prevent malicious requests where the body exceeds the capacity of the server. Set the limit to 0 to allow unbounded reads. The default is 10 Mib.

optional

type: T

Instead of utilizing the content type of the request, attempt to parse the body as the type specified. The value has to be of BodyType.

optional

contentTypes: BodyOptionsContentTypes

A map of extra content types to determine how to parse the body.