@types/js-cookie

property read

read?: CookieReadConverter<TConv> | undefined;

property write

write?: CookieWriteConverter<TConv> | undefined;

property domain

domain?: string | undefined;

• Define the domain where the cookie is available. Defaults to the domain of the page where the cookie was created.

property expires

expires?: number | Date | undefined;

• Define when the cookie will be removed. Value can be a Number which will be interpreted as days from time of creation or a Date instance. If omitted, the cookie becomes a session cookie.

property path

path?: string | undefined;

• Define the path where the cookie is available. Defaults to '/'

property sameSite

sameSite?: 'strict' | 'Strict' | 'lax' | 'Lax' | 'none' | 'None' | undefined;

• Asserts that a cookie must not be sent with cross-origin requests, providing some protection against cross-site request forgery attacks (CSRF)

property secure

secure?: boolean | undefined;

• A Boolean indicating if the cookie transmission requires a secure protocol (https). Defaults to false.

index signature

[property: string]: any;

• An attribute which will be serialized, conformably to RFC 6265 section 5.2.

property attributes

readonly attributes: CookieAttributes;

property converter

readonly converter: Required<Converter<string>>;

method get

get: { (name: string): string | T | undefined; (): { [key: string]: string } };

• Read cookie

• Read all available cookies

method remove

remove: (name: string, options?: CookieAttributes) => void;

• Delete cookie

method set

set: (
    name: string,
    value: string | T,
    options?: CookieAttributes
) => string | undefined;

• Create a cookie

method withAttributes

withAttributes: (attributes: CookieAttributes) => CookiesStatic<T>;

• Cookie attribute defaults can be set globally by creating an instance of the api via withAttributes(), or individually for each call to Cookies.set(...) by passing a plain object as the last argument. Per-call attributes override the default attributes.

method withConverter

withConverter: <TConv = string>(
    converter: Converter<TConv>
) => CookiesStatic<TConv>;

• Create a new instance of the api that overrides the default decoding implementation. All methods that rely in a proper decoding to work, such as Cookies.remove() and Cookies.get(), will run the converter first for each cookie. The returned string will be used as the cookie value.