react-router/dist/development/lib/server-runtime/sessions/cookieStorage.d.ts

Declarative routing for React

import { SessionData, SessionIdStorageStrategy, SessionStorage } from "../sessions.js";

//#region lib/server-runtime/sessions/cookieStorage.d.ts
interface CookieSessionStorageOptions {
  /**
   * The Cookie used to store the session data on the client, or options used
   * to automatically create one.
   */
  cookie?: SessionIdStorageStrategy["cookie"];
}
/**
 * Creates and returns a SessionStorage object that stores all session data
 * directly in the session cookie itself.
 *
 * This has the advantage that no database or other backend services are
 * needed, and can help to simplify some load-balanced scenarios. However, it
 * also has the limitation that serialized session data may not exceed the
 * browser's maximum cookie size. Trade-offs!
 *
 * @public
 * @category Utils
 * @mode framework
 * @mode data
 * @param options Options for creating the cookie-backed session storage.
 * @returns A {@link SessionStorage} object that stores all session data in its
 * cookie.
 */
declare function createCookieSessionStorage<Data = SessionData, FlashData = Data>({
  cookie: cookieArg
}?: CookieSessionStorageOptions): SessionStorage<Data, FlashData>;
//#endregion
export { createCookieSessionStorage };