hono/dist/types/utils/cookie.d.ts

Web framework built on Web Standards

/**
 * @module
 * Cookie utility.
 */
export type Cookie = Record<string, string>;
export type SignedCookie = Record<string, string | false>;
type PartitionedCookieConstraint = {
    partitioned: true;
    secure: true;
} | {
    partitioned?: boolean;
    secure?: boolean;
};
type SecureCookieConstraint = {
    secure: true;
};
type HostCookieConstraint = {
    secure: true;
    path: '/';
    domain?: undefined;
};
export type CookieOptions = {
    domain?: string;
    expires?: Date;
    httpOnly?: boolean;
    maxAge?: number;
    path?: string;
    secure?: boolean;
    sameSite?: 'Strict' | 'Lax' | 'None' | 'strict' | 'lax' | 'none';
    partitioned?: boolean;
    priority?: 'Low' | 'Medium' | 'High' | 'low' | 'medium' | 'high';
    prefix?: CookiePrefixOptions;
} & PartitionedCookieConstraint;
export type CookiePrefixOptions = 'host' | 'secure';
export type CookieConstraint<Name> = Name extends `__Secure-${string}` ? CookieOptions & SecureCookieConstraint : Name extends `__Host-${string}` ? CookieOptions & HostCookieConstraint : CookieOptions;
export declare const parse: (cookie: string, name?: string) => Cookie;
export declare const parseSigned: (cookie: string, secret: string | BufferSource, name?: string) => Promise<SignedCookie>;
export declare const serialize: <Name extends string>(name: Name, value: string, opt?: CookieConstraint<Name>) => string;
export declare const serializeSigned: (name: string, value: string, secret: string | BufferSource, opt?: CookieOptions) => Promise<string>;
export {};