An interface which provides an interface to access the fields of a multipart/form-data body.

Normally an instance of this is accessed when handling a request body, and dealing with decoding it. There are options that can be set when attempting to read a multi-part body (see: FormDataReadOptions).

If you .read() the value, then a promise is provided of type FormDataBody. If you use the .stream() property, it is an async iterator which yields up a tuple of with the first element being a

Examples

Using .read():

import { Application } from "https://deno.land/x/oak/mod.ts";

const app = new Application();

app.use(async (ctx) => {
  const body = ctx.request.body();
  if (body.type === "form-data") {
    const value = body.value;
    const formData = await value.read();
    // the form data is fully available
  }
});

Using .stream():

import { Application } from "https://deno.land/x/oak/mod.ts";

const app = new Application();

app.use(async (ctx) => {
  const body = ctx.request.body();
  if (body.type === "form-data") {
    const value = body.value;
    for await (const [name, value] of value.stream()) {
      // asynchronously iterate each part of the body
    }
  }
});