Function redirectToSignOut

redirectToSignOut(options?: RedirectToSignOutOptions): Promise<void>

Redirects the user to the sign-out flow.

App Router only. Intended for use in Server Components, Route Handlers, and Server Actions.

This helper performs a server-side redirect to the configured sign-out route. Execution does not continue after the redirect is triggered.

Parameters

Optionaloptions: RedirectToSignOutOptions
Optional configuration for the redirect, such as postLogoutRedirectUri or additional sign-out parameters.

Returns Promise<void>

Never resolves. Triggers a redirect to the sign-out flow.

Example: Server Component

import { getSession, redirectToSignOut } from "@monocloud/auth-nextjs";

export default async function Page() {
  const session = await getSession();

  // Example: Force sign-out if a specific condition is met (e.g., account suspended)
  if (session?.user.isSuspended) {
    await redirectToSignOut();
  }

  return <>Welcome User</>;
}

Example: Server Action

"use server";

import { getSession, redirectToSignOut } from "@monocloud/auth-nextjs";

export async function signOutAction() {
  const session = await getSession();

  if (session) {
    await redirectToSignOut();
  }
}

Example: API Handler

import { getSession, redirectToSignOut } from "@monocloud/auth-nextjs";
import { NextResponse } from "next/server";

export const GET = async () => {
  const session = await getSession();

  if (session) {
    await redirectToSignOut({
      postLogoutRedirectUri: "/goodbye",
    });
  }

  return NextResponse.json({ status: "already_signed_out" });
};