agsamantha/node_modules/tough-cookie/dist/pathMatch.d.ts
2024-10-02 15:15:21 -05:00

17 lines
893 B
TypeScript

/**
* Answers "does the request-path path-match a given cookie-path?" as per {@link https://www.rfc-editor.org/rfc/rfc6265.html#section-5.1.4 | RFC6265 Section 5.1.4}.
* This is essentially a prefix-match where cookiePath is a prefix of reqPath.
*
* @remarks
* A request-path path-matches a given cookie-path if at least one of
* the following conditions holds:
*
* - The cookie-path and the request-path are identical.
* - The cookie-path is a prefix of the request-path, and the last character of the cookie-path is %x2F ("/").
* - The cookie-path is a prefix of the request-path, and the first character of the request-path that is not included in the cookie-path is a %x2F ("/") character.
*
* @param reqPath - the path of the request
* @param cookiePath - the path of the cookie
* @public
*/
export declare function pathMatch(reqPath: string, cookiePath: string): boolean;