| 1 | import type { Nullable } from '../utils';
|
| 2 | /**
|
| 3 | * Given a current request/response path, gives the path appropriate for storing
|
| 4 | * in a cookie. This is basically the "directory" of a "file" in the path, but
|
| 5 | * is specified by {@link https://www.rfc-editor.org/rfc/rfc6265.html#section-5.1.4 | RFC6265 - Section 5.1.4}.
|
| 6 | *
|
| 7 | * @remarks
|
| 8 | * ### RFC6265 - Section 5.1.4
|
| 9 | *
|
| 10 | * The user agent MUST use an algorithm equivalent to the following algorithm to compute the default-path of a cookie:
|
| 11 | *
|
| 12 | * 1. Let uri-path be the path portion of the request-uri if such a
|
| 13 | * portion exists (and empty otherwise). For example, if the
|
| 14 | * request-uri contains just a path (and optional query string),
|
| 15 | * then the uri-path is that path (without the %x3F ("?") character
|
| 16 | * or query string), and if the request-uri contains a full
|
| 17 | * absoluteURI, the uri-path is the path component of that URI.
|
| 18 | *
|
| 19 | * 2. If the uri-path is empty or if the first character of the uri-
|
| 20 | * path is not a %x2F ("/") character, output %x2F ("/") and skip
|
| 21 | * the remaining steps.
|
| 22 | *
|
| 23 | * 3. If the uri-path contains no more than one %x2F ("/") character,
|
| 24 | * output %x2F ("/") and skip the remaining step.
|
| 25 | *
|
| 26 | * 4. Output the characters of the uri-path from the first character up
|
| 27 | * to, but not including, the right-most %x2F ("/").
|
| 28 | *
|
| 29 | * @example
|
| 30 | * ```
|
| 31 | * defaultPath('') === '/'
|
| 32 | * defaultPath('/some-path') === '/'
|
| 33 | * defaultPath('/some-parent-path/some-path') === '/some-parent-path'
|
| 34 | * defaultPath('relative-path') === '/'
|
| 35 | * ```
|
| 36 | *
|
| 37 | * @param path - the path portion of the request-uri (excluding the hostname, query, fragment, and so on)
|
| 38 | * @public
|
| 39 | */
|
| 40 | export declare function defaultPath(path?: Nullable<string>): string;
|