123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135 |
- // Type definitions for cookie 0.4
- // Project: https://github.com/jshttp/cookie
- // Definitions by: Pine Mizune <https://github.com/pine>
- // Piotr Błażejewicz <https://github.com/peterblazejewicz>
- // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
-
- /**
- * Basic HTTP cookie parser and serializer for HTTP servers.
- */
-
- /**
- * Additional serialization options
- */
- export interface CookieSerializeOptions {
- /**
- * Specifies the value for the {@link https://tools.ietf.org/html/rfc6265#section-5.2.3|Domain Set-Cookie attribute}. By default, no
- * domain is set, and most clients will consider the cookie to apply to only
- * the current domain.
- */
- domain?: string | undefined;
-
- /**
- * Specifies a function that will be used to encode a cookie's value. Since
- * value of a cookie has a limited character set (and must be a simple
- * string), this function can be used to encode a value into a string suited
- * for a cookie's value.
- *
- * The default function is the global `encodeURIComponent`, which will
- * encode a JavaScript string into UTF-8 byte sequences and then URL-encode
- * any that fall outside of the cookie range.
- */
- encode?(value: string): string;
-
- /**
- * Specifies the `Date` object to be the value for the {@link https://tools.ietf.org/html/rfc6265#section-5.2.1|`Expires` `Set-Cookie` attribute}. By default,
- * no expiration is set, and most clients will consider this a "non-persistent cookie" and will delete
- * it on a condition like exiting a web browser application.
- *
- * *Note* the {@link https://tools.ietf.org/html/rfc6265#section-5.3|cookie storage model specification}
- * states that if both `expires` and `maxAge` are set, then `maxAge` takes precedence, but it is
- * possible not all clients by obey this, so if both are set, they should
- * point to the same date and time.
- */
- expires?: Date | undefined;
- /**
- * Specifies the boolean value for the {@link https://tools.ietf.org/html/rfc6265#section-5.2.6|`HttpOnly` `Set-Cookie` attribute}.
- * When truthy, the `HttpOnly` attribute is set, otherwise it is not. By
- * default, the `HttpOnly` attribute is not set.
- *
- * *Note* be careful when setting this to true, as compliant clients will
- * not allow client-side JavaScript to see the cookie in `document.cookie`.
- */
- httpOnly?: boolean | undefined;
- /**
- * Specifies the number (in seconds) to be the value for the `Max-Age`
- * `Set-Cookie` attribute. The given number will be converted to an integer
- * by rounding down. By default, no maximum age is set.
- *
- * *Note* the {@link https://tools.ietf.org/html/rfc6265#section-5.3|cookie storage model specification}
- * states that if both `expires` and `maxAge` are set, then `maxAge` takes precedence, but it is
- * possible not all clients by obey this, so if both are set, they should
- * point to the same date and time.
- */
- maxAge?: number | undefined;
- /**
- * Specifies the value for the {@link https://tools.ietf.org/html/rfc6265#section-5.2.4|`Path` `Set-Cookie` attribute}.
- * By default, the path is considered the "default path".
- */
- path?: string | undefined;
- /**
- * Specifies the boolean or string to be the value for the {@link https://tools.ietf.org/html/draft-ietf-httpbis-rfc6265bis-03#section-4.1.2.7|`SameSite` `Set-Cookie` attribute}.
- *
- * - `true` will set the `SameSite` attribute to `Strict` for strict same
- * site enforcement.
- * - `false` will not set the `SameSite` attribute.
- * - `'lax'` will set the `SameSite` attribute to Lax for lax same site
- * enforcement.
- * - `'strict'` will set the `SameSite` attribute to Strict for strict same
- * site enforcement.
- * - `'none'` will set the SameSite attribute to None for an explicit
- * cross-site cookie.
- *
- * More information about the different enforcement levels can be found in {@link https://tools.ietf.org/html/draft-ietf-httpbis-rfc6265bis-03#section-4.1.2.7|the specification}.
- *
- * *note* This is an attribute that has not yet been fully standardized, and may change in the future. This also means many clients may ignore this attribute until they understand it.
- */
- sameSite?: true | false | 'lax' | 'strict' | 'none' | undefined;
- /**
- * Specifies the boolean value for the {@link https://tools.ietf.org/html/rfc6265#section-5.2.5|`Secure` `Set-Cookie` attribute}. When truthy, the
- * `Secure` attribute is set, otherwise it is not. By default, the `Secure` attribute is not set.
- *
- * *Note* be careful when setting this to `true`, as compliant clients will
- * not send the cookie back to the server in the future if the browser does
- * not have an HTTPS connection.
- */
- secure?: boolean | undefined;
- }
-
- /**
- * Additional parsing options
- */
- export interface CookieParseOptions {
- /**
- * Specifies a function that will be used to decode a cookie's value. Since
- * the value of a cookie has a limited character set (and must be a simple
- * string), this function can be used to decode a previously-encoded cookie
- * value into a JavaScript string or other object.
- *
- * The default function is the global `decodeURIComponent`, which will decode
- * any URL-encoded sequences into their byte representations.
- *
- * *Note* if an error is thrown from this function, the original, non-decoded
- * cookie value will be returned as the cookie's value.
- */
- decode?(value: string): string;
- }
-
- /**
- * Parse an HTTP Cookie header string and returning an object of all cookie
- * name-value pairs.
- *
- * @param str the string representing a `Cookie` header value
- * @param [options] object containing parsing options
- */
- export function parse(str: string, options?: CookieParseOptions): { [key: string]: string };
-
- /**
- * Serialize a cookie name-value pair into a `Set-Cookie` header string.
- *
- * @param name the name for the cookie
- * @param value value to set the cookie to
- * @param [options] object containing serialization options
- * @throws {TypeError} when `maxAge` options is invalid
- */
- export function serialize(name: string, value: string, options?: CookieSerializeOptions): string;
|