UNPKG

@remix-run/server-runtime

Version:
24 lines (23 loc) 1.15 kB
import type { CreateCookieFunction } from "../cookies"; import type { SessionStorage, SessionIdStorageStrategy, SessionData } from "../sessions"; interface CookieSessionStorageOptions { /** * The Cookie used to store the session data on the client, or options used * to automatically create one. */ cookie?: SessionIdStorageStrategy["cookie"]; } export type CreateCookieSessionStorageFunction = <Data = SessionData, FlashData = Data>(options?: CookieSessionStorageOptions) => SessionStorage<Data, FlashData>; /** * 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! * * @see https://remix.run/utils/sessions#createcookiesessionstorage */ export declare const createCookieSessionStorageFactory: (createCookie: CreateCookieFunction) => CreateCookieSessionStorageFunction; export {};