redirectDocument

[MODES: framework, data]

Summary

Reference Documentation ↗

A redirect Response that will force a document reload to the new location. Sets the status code and the Location header. Defaults to 302 Found.

tsx

import { redirectDocument } from "react-router";

import { destroySession } from "../sessions.server";

export async function action({ request }: Route.ActionArgs) {
  let session = await getSession(request.headers.get("Cookie"));
  return redirectDocument("/", {
    headers: { "Set-Cookie": await destroySession(session) }
  });
}

Params

url

The URL to redirect to.

init

The status code or a ResponseInit object to be included in the response.

Returns

A Response object with the redirect status and Location header.