File size: 28,594 Bytes
5fae594 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 |
import { Store } from '../store';
import { Cookie } from './cookie';
import { Callback, ErrorCallback, Nullable } from '../utils';
import { SerializedCookieJar } from './constants';
/**
* Configuration options used when calling `CookieJar.setCookie(...)`
* @public
*/
export interface SetCookieOptions {
/**
* Controls if a cookie string should be parsed using `loose` mode or not.
* See {@link Cookie.parse} and {@link ParseCookieOptions} for more details.
*
* Defaults to `false` if not provided.
*/
loose?: boolean | undefined;
/**
* Set this to 'none', 'lax', or 'strict' to enforce SameSite cookies upon storage.
*
* - `'strict'` - If the request is on the same "site for cookies" (see the RFC draft
* for more information), pass this option to add a layer of defense against CSRF.
*
* - `'lax'` - If the request is from another site, but is directly because of navigation
* by the user, such as, `<link type=prefetch>` or `<a href="...">`, then use `lax`.
*
* - `'none'` - This indicates a cross-origin request.
*
* - `undefined` - SameSite is not be enforced! This can be a valid use-case for when
* CSRF isn't in the threat model of the system being built.
*
* Defaults to `undefined` if not provided.
*
* @remarks
* - It is highly recommended that you read {@link https://tools.ietf.org/html/draft-ietf-httpbis-rfc6265bis-02##section-8.8 | RFC6265bis - Section 8.8}
* which discusses security considerations and defence on SameSite cookies in depth.
*/
sameSiteContext?: 'strict' | 'lax' | 'none' | undefined;
/**
* Silently ignore things like parse errors and invalid domains. Store errors aren't ignored by this option.
*
* Defaults to `false` if not provided.
*/
ignoreError?: boolean | undefined;
/**
* Indicates if this is an HTTP or non-HTTP API. Affects HttpOnly cookies.
*
* Defaults to `true` if not provided.
*/
http?: boolean | undefined;
/**
* Forces the cookie creation and access time of cookies to this value when stored.
*
* Defaults to `Date.now()` if not provided.
*/
now?: Date | undefined;
}
/**
* Configuration options used when calling `CookieJar.getCookies(...)`.
* @public
*/
export interface GetCookiesOptions {
/**
* Indicates if this is an HTTP or non-HTTP API. Affects HttpOnly cookies.
*
* Defaults to `true` if not provided.
*/
http?: boolean | undefined;
/**
* Perform `expiry-time` checking of cookies and asynchronously remove expired
* cookies from the store.
*
* @remarks
* - Using `false` returns expired cookies and does not remove them from the
* store which is potentially useful for replaying `Set-Cookie` headers.
*
* Defaults to `true` if not provided.
*/
expire?: boolean | undefined;
/**
* If `true`, do not scope cookies by path. If `false`, then RFC-compliant path scoping will be used.
*
* @remarks
* - May not be supported by the underlying store (the default {@link MemoryCookieStore} supports it).
*
* Defaults to `false` if not provided.
*/
allPaths?: boolean | undefined;
/**
* Set this to 'none', 'lax', or 'strict' to enforce SameSite cookies upon retrieval.
*
* - `'strict'` - If the request is on the same "site for cookies" (see the RFC draft
* for more information), pass this option to add a layer of defense against CSRF.
*
* - `'lax'` - If the request is from another site, but is directly because of navigation
* by the user, such as, `<link type=prefetch>` or `<a href="...">`, then use `lax`.
*
* - `'none'` - This indicates a cross-origin request.
*
* - `undefined` - SameSite is not be enforced! This can be a valid use-case for when
* CSRF isn't in the threat model of the system being built.
*
* Defaults to `undefined` if not provided.
*
* @remarks
* - It is highly recommended that you read {@link https://tools.ietf.org/html/draft-ietf-httpbis-rfc6265bis-02##section-8.8 | RFC6265bis - Section 8.8}
* which discusses security considerations and defence on SameSite cookies in depth.
*/
sameSiteContext?: 'none' | 'lax' | 'strict' | undefined;
/**
* Flag to indicate if the returned cookies should be sorted or not.
*
* Defaults to `undefined` if not provided.
*/
sort?: boolean | undefined;
}
/**
* Configuration settings to be used with a {@link CookieJar}.
* @public
*/
export interface CreateCookieJarOptions {
/**
* Reject cookies that match those defined in the {@link https://publicsuffix.org/ | Public Suffix List} (e.g.; domains like "com" and "co.uk").
*
* Defaults to `true` if not specified.
*/
rejectPublicSuffixes?: boolean | undefined;
/**
* Accept malformed cookies like `bar` and `=bar`, which have an implied empty name but are not RFC-compliant.
*
* Defaults to `false` if not specified.
*/
looseMode?: boolean | undefined;
/**
* Controls how cookie prefixes are handled. See {@link PrefixSecurityEnum}.
*
* Defaults to `silent` if not specified.
*/
prefixSecurity?: 'strict' | 'silent' | 'unsafe-disabled' | undefined;
/**
* Accepts {@link https://datatracker.ietf.org/doc/html/rfc6761 | special-use domains } such as `local`.
* This is not in the standard, but is used sometimes on the web and is accepted by most browsers. It is
* also useful for testing purposes.
*
* Defaults to `true` if not specified.
*/
allowSpecialUseDomain?: boolean | undefined;
}
/**
* A CookieJar is for storage and retrieval of {@link Cookie} objects as defined in
* {@link https://www.rfc-editor.org/rfc/rfc6265.html#section-5.3 | RFC6265 - Section 5.3}.
*
* It also supports a pluggable persistence layer via {@link Store}.
* @public
*/
export declare class CookieJar {
private readonly rejectPublicSuffixes;
private readonly enableLooseMode;
private readonly allowSpecialUseDomain;
/**
* The configured {@link Store} for the {@link CookieJar}.
*/
readonly store: Store;
/**
* The configured {@link PrefixSecurityEnum} value for the {@link CookieJar}.
*/
readonly prefixSecurity: string;
/**
* Creates a new `CookieJar` instance.
*
* @remarks
* - If a custom store is not passed to the constructor, an in-memory store ({@link MemoryCookieStore} will be created and used.
* - If a boolean value is passed as the `options` parameter, this is equivalent to passing `{ rejectPublicSuffixes: <value> }`
*
* @param store - a custom {@link Store} implementation (defaults to {@link MemoryCookieStore})
* @param options - configures how cookies are processed by the cookie jar
*/
constructor(store?: Nullable<Store>, options?: CreateCookieJarOptions | boolean);
private callSync;
/**
* Attempt to set the {@link Cookie} in the {@link CookieJar}.
*
* @remarks
* - If successfully persisted, the {@link Cookie} will have updated
* {@link Cookie.creation}, {@link Cookie.lastAccessed} and {@link Cookie.hostOnly}
* properties.
*
* - As per the RFC, the {@link Cookie.hostOnly} flag is set if there was no `Domain={value}`
* atttribute on the cookie string. The {@link Cookie.domain} property is set to the
* fully-qualified hostname of `currentUrl` in this case. Matching this cookie requires an
* exact hostname match (not a {@link domainMatch} as per usual)
*
* @param cookie - The cookie object or cookie string to store. A string value will be parsed into a cookie using {@link Cookie.parse}.
* @param url - The domain to store the cookie with.
* @param callback - A function to call after a cookie has been successfully stored.
* @public
*/
setCookie(cookie: string | Cookie, url: string | URL, callback: Callback<Cookie | undefined>): void;
/**
* Attempt to set the {@link Cookie} in the {@link CookieJar}.
*
* @remarks
* - If successfully persisted, the {@link Cookie} will have updated
* {@link Cookie.creation}, {@link Cookie.lastAccessed} and {@link Cookie.hostOnly}
* properties.
*
* - As per the RFC, the {@link Cookie.hostOnly} flag is set if there was no `Domain={value}`
* atttribute on the cookie string. The {@link Cookie.domain} property is set to the
* fully-qualified hostname of `currentUrl` in this case. Matching this cookie requires an
* exact hostname match (not a {@link domainMatch} as per usual)
*
* @param cookie - The cookie object or cookie string to store. A string value will be parsed into a cookie using {@link Cookie.parse}.
* @param url - The domain to store the cookie with.
* @param options - Configuration settings to use when storing the cookie.
* @param callback - A function to call after a cookie has been successfully stored.
* @public
*/
setCookie(cookie: string | Cookie, url: string | URL, options: SetCookieOptions, callback: Callback<Cookie | undefined>): void;
/**
* Attempt to set the {@link Cookie} in the {@link CookieJar}.
*
* @remarks
* - If successfully persisted, the {@link Cookie} will have updated
* {@link Cookie.creation}, {@link Cookie.lastAccessed} and {@link Cookie.hostOnly}
* properties.
*
* - As per the RFC, the {@link Cookie.hostOnly} flag is set if there was no `Domain={value}`
* atttribute on the cookie string. The {@link Cookie.domain} property is set to the
* fully-qualified hostname of `currentUrl` in this case. Matching this cookie requires an
* exact hostname match (not a {@link domainMatch} as per usual)
*
* @param cookie - The cookie object or cookie string to store. A string value will be parsed into a cookie using {@link Cookie.parse}.
* @param url - The domain to store the cookie with.
* @param options - Configuration settings to use when storing the cookie.
* @public
*/
setCookie(cookie: string | Cookie, url: string | URL, options?: SetCookieOptions): Promise<Cookie | undefined>;
/**
* @internal No doc because this is an overload that supports the implementation
*/
setCookie(cookie: string | Cookie, url: string | URL, options: SetCookieOptions | Callback<Cookie | undefined>, callback?: Callback<Cookie | undefined>): unknown;
/**
* Synchronously attempt to set the {@link Cookie} in the {@link CookieJar}.
*
* <strong>Note:</strong> Only works if the configured {@link Store} is also synchronous.
*
* @remarks
* - If successfully persisted, the {@link Cookie} will have updated
* {@link Cookie.creation}, {@link Cookie.lastAccessed} and {@link Cookie.hostOnly}
* properties.
*
* - As per the RFC, the {@link Cookie.hostOnly} flag is set if there was no `Domain={value}`
* atttribute on the cookie string. The {@link Cookie.domain} property is set to the
* fully-qualified hostname of `currentUrl` in this case. Matching this cookie requires an
* exact hostname match (not a {@link domainMatch} as per usual)
*
* @param cookie - The cookie object or cookie string to store. A string value will be parsed into a cookie using {@link Cookie.parse}.
* @param url - The domain to store the cookie with.
* @param options - Configuration settings to use when storing the cookie.
* @public
*/
setCookieSync(cookie: string | Cookie, url: string, options?: SetCookieOptions): Cookie | undefined;
/**
* Retrieve the list of cookies that can be sent in a Cookie header for the
* current URL.
*
* @remarks
* - The array of cookies returned will be sorted according to {@link cookieCompare}.
*
* - The {@link Cookie.lastAccessed} property will be updated on all returned cookies.
*
* @param url - The domain to store the cookie with.
*/
getCookies(url: string): Promise<Cookie[]>;
/**
* Retrieve the list of cookies that can be sent in a Cookie header for the
* current URL.
*
* @remarks
* - The array of cookies returned will be sorted according to {@link cookieCompare}.
*
* - The {@link Cookie.lastAccessed} property will be updated on all returned cookies.
*
* @param url - The domain to store the cookie with.
* @param callback - A function to call after a cookie has been successfully retrieved.
*/
getCookies(url: string, callback: Callback<Cookie[]>): void;
/**
* Retrieve the list of cookies that can be sent in a Cookie header for the
* current URL.
*
* @remarks
* - The array of cookies returned will be sorted according to {@link cookieCompare}.
*
* - The {@link Cookie.lastAccessed} property will be updated on all returned cookies.
*
* @param url - The domain to store the cookie with.
* @param options - Configuration settings to use when retrieving the cookies.
* @param callback - A function to call after a cookie has been successfully retrieved.
*/
getCookies(url: string | URL, options: GetCookiesOptions | undefined, callback: Callback<Cookie[]>): void;
/**
* Retrieve the list of cookies that can be sent in a Cookie header for the
* current URL.
*
* @remarks
* - The array of cookies returned will be sorted according to {@link cookieCompare}.
*
* - The {@link Cookie.lastAccessed} property will be updated on all returned cookies.
*
* @param url - The domain to store the cookie with.
* @param options - Configuration settings to use when retrieving the cookies.
*/
getCookies(url: string | URL, options?: GetCookiesOptions | undefined): Promise<Cookie[]>;
/**
* @internal No doc because this is an overload that supports the implementation
*/
getCookies(url: string | URL, options: GetCookiesOptions | undefined | Callback<Cookie[]>, callback?: Callback<Cookie[]>): unknown;
/**
* Synchronously retrieve the list of cookies that can be sent in a Cookie header for the
* current URL.
*
* <strong>Note</strong>: Only works if the configured Store is also synchronous.
*
* @remarks
* - The array of cookies returned will be sorted according to {@link cookieCompare}.
*
* - The {@link Cookie.lastAccessed} property will be updated on all returned cookies.
*
* @param url - The domain to store the cookie with.
* @param options - Configuration settings to use when retrieving the cookies.
*/
getCookiesSync(url: string, options?: GetCookiesOptions): Cookie[];
/**
* Accepts the same options as `.getCookies()` but returns a string suitable for a
* `Cookie` header rather than an Array.
*
* @param url - The domain to store the cookie with.
* @param options - Configuration settings to use when retrieving the cookies.
* @param callback - A function to call after the `Cookie` header string has been created.
*/
getCookieString(url: string, options: GetCookiesOptions, callback: Callback<string | undefined>): void;
/**
* Accepts the same options as `.getCookies()` but returns a string suitable for a
* `Cookie` header rather than an Array.
*
* @param url - The domain to store the cookie with.
* @param callback - A function to call after the `Cookie` header string has been created.
*/
getCookieString(url: string, callback: Callback<string | undefined>): void;
/**
* Accepts the same options as `.getCookies()` but returns a string suitable for a
* `Cookie` header rather than an Array.
*
* @param url - The domain to store the cookie with.
* @param options - Configuration settings to use when retrieving the cookies.
*/
getCookieString(url: string, options?: GetCookiesOptions): Promise<string>;
/**
* @internal No doc because this is an overload that supports the implementation
*/
getCookieString(url: string, options: GetCookiesOptions | Callback<string | undefined>, callback?: Callback<string | undefined>): unknown;
/**
* Synchronous version of `.getCookieString()`. Accepts the same options as `.getCookies()` but returns a string suitable for a
* `Cookie` header rather than an Array.
*
* <strong>Note</strong>: Only works if the configured Store is also synchronous.
*
* @param url - The domain to store the cookie with.
* @param options - Configuration settings to use when retrieving the cookies.
*/
getCookieStringSync(url: string, options?: GetCookiesOptions): string;
/**
* Returns an array of strings suitable for `Set-Cookie` headers. Accepts the same options
* as `.getCookies()`.
*
* @param url - The domain to store the cookie with.
* @param callback - A function to call after the `Set-Cookie` header strings have been created.
*/
getSetCookieStrings(url: string, callback: Callback<string[] | undefined>): void;
/**
* Returns an array of strings suitable for `Set-Cookie` headers. Accepts the same options
* as `.getCookies()`.
*
* @param url - The domain to store the cookie with.
* @param options - Configuration settings to use when retrieving the cookies.
* @param callback - A function to call after the `Set-Cookie` header strings have been created.
*/
getSetCookieStrings(url: string, options: GetCookiesOptions, callback: Callback<string[] | undefined>): void;
/**
* Returns an array of strings suitable for `Set-Cookie` headers. Accepts the same options
* as `.getCookies()`.
*
* @param url - The domain to store the cookie with.
* @param options - Configuration settings to use when retrieving the cookies.
*/
getSetCookieStrings(url: string, options?: GetCookiesOptions): Promise<string[] | undefined>;
/**
* @internal No doc because this is an overload that supports the implementation
*/
getSetCookieStrings(url: string, options: GetCookiesOptions, callback?: Callback<string[] | undefined>): unknown;
/**
* Synchronous version of `.getSetCookieStrings()`. Returns an array of strings suitable for `Set-Cookie` headers.
* Accepts the same options as `.getCookies()`.
*
* <strong>Note</strong>: Only works if the configured Store is also synchronous.
*
* @param url - The domain to store the cookie with.
* @param options - Configuration settings to use when retrieving the cookies.
*/
getSetCookieStringsSync(url: string, options?: GetCookiesOptions): string[];
/**
* Serialize the CookieJar if the underlying store supports `.getAllCookies`.
* @param callback - A function to call after the CookieJar has been serialized
*/
serialize(callback: Callback<SerializedCookieJar>): void;
/**
* Serialize the CookieJar if the underlying store supports `.getAllCookies`.
*/
serialize(): Promise<SerializedCookieJar>;
/**
* Serialize the CookieJar if the underlying store supports `.getAllCookies`.
*
* <strong>Note</strong>: Only works if the configured Store is also synchronous.
*/
serializeSync(): SerializedCookieJar | undefined;
/**
* Alias of {@link CookieJar.serializeSync}. Allows the cookie to be serialized
* with `JSON.stringify(cookieJar)`.
*/
toJSON(): SerializedCookieJar | undefined;
/**
* Use the class method CookieJar.deserialize instead of calling this directly
* @internal
*/
_importCookies(serialized: unknown, callback: Callback<CookieJar>): void;
/**
* @internal
*/
_importCookiesSync(serialized: unknown): void;
/**
* Produces a deep clone of this CookieJar. Modifications to the original do
* not affect the clone, and vice versa.
*
* @remarks
* - When no {@link Store} is provided, a new {@link MemoryCookieStore} will be used.
*
* - Transferring between store types is supported so long as the source
* implements `.getAllCookies()` and the destination implements `.putCookie()`.
*
* @param callback - A function to call when the CookieJar is cloned.
*/
clone(callback: Callback<CookieJar>): void;
/**
* Produces a deep clone of this CookieJar. Modifications to the original do
* not affect the clone, and vice versa.
*
* @remarks
* - When no {@link Store} is provided, a new {@link MemoryCookieStore} will be used.
*
* - Transferring between store types is supported so long as the source
* implements `.getAllCookies()` and the destination implements `.putCookie()`.
*
* @param newStore - The target {@link Store} to clone cookies into.
* @param callback - A function to call when the CookieJar is cloned.
*/
clone(newStore: Store, callback: Callback<CookieJar>): void;
/**
* Produces a deep clone of this CookieJar. Modifications to the original do
* not affect the clone, and vice versa.
*
* @remarks
* - When no {@link Store} is provided, a new {@link MemoryCookieStore} will be used.
*
* - Transferring between store types is supported so long as the source
* implements `.getAllCookies()` and the destination implements `.putCookie()`.
*
* @param newStore - The target {@link Store} to clone cookies into.
*/
clone(newStore?: Store): Promise<CookieJar>;
/**
* @internal
*/
_cloneSync(newStore?: Store): CookieJar | undefined;
/**
* Produces a deep clone of this CookieJar. Modifications to the original do
* not affect the clone, and vice versa.
*
* <strong>Note</strong>: Only works if both the configured Store and destination
* Store are synchronous.
*
* @remarks
* - When no {@link Store} is provided, a new {@link MemoryCookieStore} will be used.
*
* - Transferring between store types is supported so long as the source
* implements `.getAllCookies()` and the destination implements `.putCookie()`.
*
* @param newStore - The target {@link Store} to clone cookies into.
*/
cloneSync(newStore?: Store): CookieJar | undefined;
/**
* Removes all cookies from the CookieJar.
*
* @remarks
* - This is a new backwards-compatible feature of tough-cookie version 2.5,
* so not all Stores will implement it efficiently. For Stores that do not
* implement `removeAllCookies`, the fallback is to call `removeCookie` after
* `getAllCookies`.
*
* - If `getAllCookies` fails or isn't implemented in the Store, an error is returned.
*
* - If one or more of the `removeCookie` calls fail, only the first error is returned.
*
* @param callback - A function to call when all the cookies have been removed.
*/
removeAllCookies(callback: ErrorCallback): void;
/**
* Removes all cookies from the CookieJar.
*
* @remarks
* - This is a new backwards-compatible feature of tough-cookie version 2.5,
* so not all Stores will implement it efficiently. For Stores that do not
* implement `removeAllCookies`, the fallback is to call `removeCookie` after
* `getAllCookies`.
*
* - If `getAllCookies` fails or isn't implemented in the Store, an error is returned.
*
* - If one or more of the `removeCookie` calls fail, only the first error is returned.
*/
removeAllCookies(): Promise<void>;
/**
* Removes all cookies from the CookieJar.
*
* <strong>Note</strong>: Only works if the configured Store is also synchronous.
*
* @remarks
* - This is a new backwards-compatible feature of tough-cookie version 2.5,
* so not all Stores will implement it efficiently. For Stores that do not
* implement `removeAllCookies`, the fallback is to call `removeCookie` after
* `getAllCookies`.
*
* - If `getAllCookies` fails or isn't implemented in the Store, an error is returned.
*
* - If one or more of the `removeCookie` calls fail, only the first error is returned.
*/
removeAllCookiesSync(): void;
/**
* A new CookieJar is created and the serialized {@link Cookie} values are added to
* the underlying store. Each {@link Cookie} is added via `store.putCookie(...)` in
* the order in which they appear in the serialization.
*
* @remarks
* - When no {@link Store} is provided, a new {@link MemoryCookieStore} will be used.
*
* - As a convenience, if `strOrObj` is a string, it is passed through `JSON.parse` first.
*
* @param strOrObj - A JSON string or object representing the deserialized cookies.
* @param callback - A function to call after the {@link CookieJar} has been deserialized.
*/
static deserialize(strOrObj: string | object, callback: Callback<CookieJar>): void;
/**
* A new CookieJar is created and the serialized {@link Cookie} values are added to
* the underlying store. Each {@link Cookie} is added via `store.putCookie(...)` in
* the order in which they appear in the serialization.
*
* @remarks
* - When no {@link Store} is provided, a new {@link MemoryCookieStore} will be used.
*
* - As a convenience, if `strOrObj` is a string, it is passed through `JSON.parse` first.
*
* @param strOrObj - A JSON string or object representing the deserialized cookies.
* @param store - The underlying store to persist the deserialized cookies into.
* @param callback - A function to call after the {@link CookieJar} has been deserialized.
*/
static deserialize(strOrObj: string | object, store: Store, callback: Callback<CookieJar>): void;
/**
* A new CookieJar is created and the serialized {@link Cookie} values are added to
* the underlying store. Each {@link Cookie} is added via `store.putCookie(...)` in
* the order in which they appear in the serialization.
*
* @remarks
* - When no {@link Store} is provided, a new {@link MemoryCookieStore} will be used.
*
* - As a convenience, if `strOrObj` is a string, it is passed through `JSON.parse` first.
*
* @param strOrObj - A JSON string or object representing the deserialized cookies.
* @param store - The underlying store to persist the deserialized cookies into.
*/
static deserialize(strOrObj: string | object, store?: Store): Promise<CookieJar>;
/**
* @internal No doc because this is an overload that supports the implementation
*/
static deserialize(strOrObj: string | object, store?: Store | Callback<CookieJar>, callback?: Callback<CookieJar>): unknown;
/**
* A new CookieJar is created and the serialized {@link Cookie} values are added to
* the underlying store. Each {@link Cookie} is added via `store.putCookie(...)` in
* the order in which they appear in the serialization.
*
* <strong>Note</strong>: Only works if the configured Store is also synchronous.
*
* @remarks
* - When no {@link Store} is provided, a new {@link MemoryCookieStore} will be used.
*
* - As a convenience, if `strOrObj` is a string, it is passed through `JSON.parse` first.
*
* @param strOrObj - A JSON string or object representing the deserialized cookies.
* @param store - The underlying store to persist the deserialized cookies into.
*/
static deserializeSync(strOrObj: string | SerializedCookieJar, store?: Store): CookieJar;
/**
* Alias of {@link CookieJar.deserializeSync}.
*
* @remarks
* - When no {@link Store} is provided, a new {@link MemoryCookieStore} will be used.
*
* - As a convenience, if `strOrObj` is a string, it is passed through `JSON.parse` first.
*
* @param jsonString - A JSON string or object representing the deserialized cookies.
* @param store - The underlying store to persist the deserialized cookies into.
*/
static fromJSON(jsonString: string | SerializedCookieJar, store?: Store): CookieJar;
}
|