rjweb-server/lib/typings/classes/Cookie.d.ts

Easy and Robust Way to create a Web Server with Many Easy-to-use Features in NodeJS

import { Content } from "../types/global";
type CookieData = {
    /**
     * The Domain this Cookie will be assigned to.
     *
     * If not provided will not be used in the Cookie Header.
     * @default null
     * @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie#attributes
     * @since 9.0.0
    */ domain?: string;
    /**
     * Whether the Cookie should be HTTP only
     * @default false
     * @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie#attributes
     * @since 9.0.0
    */ httpOnly?: boolean;
    /**
     * Whether the Cookie should be Secure (HTTPS only)
     * @default false
     * @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie#attributes
     * @since 9.0.0
    */ secure?: boolean;
    /**
     * The Path under which to save the Cookie
     * @default "/"
     * @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie#attributes
     * @since 9.0.0
    */ path?: string;
    /**
     * The SameSite Attribute of the Cookie
     * @default false
     * @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie#attributes
     * @since 9.0.0
    */ sameSite?: false | 'strict' | 'lax' | 'none';
    /**
     * The Date or seconds in which the Cookie will expire
     *
     * If not provided will create a "Session Cookie".
     * @default null
     * @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie#attributes
     * @since 9.0.0
    */ expires?: Date | number;
};
export default class Cookie {
    /**
     * Create a new Cookie
     * @example
     * ```
     * import { Cookie } from "rjweb-server"
     *
     * const cookie = new Cookie('value', {
     *   expires: 50000
     * })
     * ```
     * @since 9.0.0
    */ constructor(value: Content, data?: CookieData);
    /**
     * The Domain this Cookie will be assigned to.
     *
     * If not provided will not be used in the Cookie Header.
     * @default null
     * @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie#attributes
     * @since 9.0.0
    */ readonly domain: string | null;
    /**
     * Whether the Cookie should be HTTP only
     * @default false
     * @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie#attributes
     * @since 9.0.0
    */ readonly httpOnly: boolean;
    /**
     * Whether the Cookie should be Secure (HTTPS only)
     * @default false
     * @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie#attributes
     * @since 9.0.0
    */ readonly secure: boolean;
    /**
     * The Path under which to save the Cookie
     * @default "/"
     * @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie#attributes
     * @since 9.0.0
    */ readonly path: string;
    /**
     * The SameSite Attribute of the Cookie
     * @default false
     * @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie#attributes
     * @since 9.0.0
    */ readonly sameSite: false | 'strict' | 'lax' | 'none';
    /**
     * The Date or seconds in which the Cookie will expire
     *
     * If not provided will create a "Session Cookie".
     * @default null
     * @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie#attributes
     * @since 9.0.0
    */ readonly expires: Date | number | null;
    /**
     * The Value of the Cookie
     * @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie#attributes
     * @since 9.0.0
    */ readonly value: Content;
}
export {};