From fafaf72cf1fd22ff88d47c9c316315814fd193e1 Mon Sep 17 00:00:00 2001 From: Colin Casey Date: Thu, 11 Apr 2024 11:03:48 -0300 Subject: [PATCH] GitHub Action changes for API and docs --- .eslintrc.json | 2 +- .github/workflows/integration.yaml | 79 +- api-extractor.json | 2 +- api/.gitattributes | 1 + .../tough-cookie.cookiejar._constructor_.md | 140 +- api/docs/tough-cookie.cookiejar.clone.md | 118 +- api/docs/tough-cookie.cookiejar.clone_1.md | 150 +- api/docs/tough-cookie.cookiejar.clone_2.md | 118 +- api/docs/tough-cookie.cookiejar.clonesync.md | 122 +- .../tough-cookie.cookiejar.deserialize.md | 150 +- .../tough-cookie.cookiejar.deserialize_1.md | 182 +-- .../tough-cookie.cookiejar.deserialize_2.md | 150 +- .../tough-cookie.cookiejar.deserializesync.md | 154 +-- api/docs/tough-cookie.cookiejar.fromjson.md | 150 +- api/docs/tough-cookie.cookiejar.getcookies.md | 150 +- .../tough-cookie.cookiejar.getcookies_1.md | 182 +-- .../tough-cookie.cookiejar.getcookies_2.md | 150 +- .../tough-cookie.cookiejar.getcookiessync.md | 154 +-- .../tough-cookie.cookiejar.getcookiestring.md | 170 +-- ...ough-cookie.cookiejar.getcookiestring_1.md | 138 +- ...ough-cookie.cookiejar.getcookiestring_2.md | 138 +- ...gh-cookie.cookiejar.getcookiestringsync.md | 142 +- ...gh-cookie.cookiejar.getsetcookiestrings.md | 138 +- ...-cookie.cookiejar.getsetcookiestrings_1.md | 170 +-- ...-cookie.cookiejar.getsetcookiestrings_2.md | 138 +- ...ookie.cookiejar.getsetcookiestringssync.md | 142 +- api/docs/tough-cookie.cookiejar.md | 1220 ++++++++--------- .../tough-cookie.cookiejar.prefixsecurity.md | 26 +- ...tough-cookie.cookiejar.removeallcookies.md | 122 +- ...ugh-cookie.cookiejar.removeallcookies_1.md | 50 +- ...h-cookie.cookiejar.removeallcookiessync.md | 54 +- api/docs/tough-cookie.cookiejar.serialize.md | 106 +- .../tough-cookie.cookiejar.serialize_1.md | 34 +- .../tough-cookie.cookiejar.serializesync.md | 38 +- api/docs/tough-cookie.cookiejar.setcookie.md | 182 +-- .../tough-cookie.cookiejar.setcookie_1.md | 214 +-- .../tough-cookie.cookiejar.setcookie_2.md | 182 +-- .../tough-cookie.cookiejar.setcookiesync.md | 186 +-- api/docs/tough-cookie.cookiejar.store.md | 26 +- api/docs/tough-cookie.cookiejar.tojson.md | 34 +- api/docs/tough-cookie.getpublicsuffix.md | 162 +-- .../tough-cookie.getpublicsuffixoptions.md | 152 +- lib/__tests__/data/parser.ts | 1 - lib/cookie/cookie.ts | 4 - lib/cookie/cookieJar.ts | 3 - package-lock.json | 606 +++++++- 46 files changed, 3679 insertions(+), 3053 deletions(-) create mode 100644 api/.gitattributes diff --git a/.eslintrc.json b/.eslintrc.json index 80d4ed74..50450a60 100644 --- a/.eslintrc.json +++ b/.eslintrc.json @@ -14,6 +14,6 @@ "reportUnusedDisableDirectives": true, "rules": { "@typescript-eslint/explicit-function-return-type": "error", - "max-lines": ["warn", 500] + "max-lines": ["warn", 2000] } } diff --git a/.github/workflows/integration.yaml b/.github/workflows/integration.yaml index d339d48a..2ed23f3c 100644 --- a/.github/workflows/integration.yaml +++ b/.github/workflows/integration.yaml @@ -1,28 +1,81 @@ -name: Actions-CI +name: CI on: push: - branches: [master, v5] + branches: [master] pull_request: - branches: [master, v5] + +permissions: + contents: read jobs: - build: + lint: + name: Lint runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v4 + - name: Setup Node.js + uses: actions/setup-node@v4 + with: + node-version: lts/* + cache: npm + - name: Install dependencies + run: npm ci + - name: Run Linter + run: npm run eslint + - name: Run Formatter + run: npm run prettier + test: + name: Test - ${{ matrix.node-version }} + runs-on: ubuntu-latest strategy: matrix: node-version: [latest, lts/*, lts/-1] - steps: - - uses: actions/checkout@v2 - - name: Use Node.js ${{ matrix.node-version }} - uses: actions/setup-node@v3 + - name: Checkout + uses: actions/checkout@v4 + - name: Setup Node.js (${{ matrix.node-version }}) + uses: actions/setup-node@v4 with: node-version: ${{ matrix.node-version }} cache: npm - - name: Install dependencies and test - run: npm install - - run: npm test - - run: npm run eslint - - run: npm run prettier + - name: Install dependencies + run: npm ci + - name: Run tests + run: npm test + + api: + name: API & Doc Validation + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v4 + - name: Setup Node.js + uses: actions/setup-node@v4 + with: + node-version: lts/* + cache: npm + - name: Install dependencies + run: npm ci + - name: Build + run: npm run build + - name: Extract API + run: npm run api:extract + - name: Generate docs + run: npm run api:docs + - name: Ensure API and doc changes have been committed + run: | + git add --renormalize . + if (( "$(git diff --ignore-space-at-eol --ignore-cr-at-eol | wc -l)" != 0 )); then + cat << EOF >> $GITHUB_STEP_SUMMARY + ### Detected uncommitted changes + + \`\`\`shell + $(git diff) + \`\`\` + EOF + git diff + exit 1 + fi diff --git a/api-extractor.json b/api-extractor.json index 0716ab9f..c44f39bb 100644 --- a/api-extractor.json +++ b/api-extractor.json @@ -1,7 +1,7 @@ { "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json", "mainEntryPointFilePath": "/dist/cookie/index.d.ts", - "newlineKind": "os", + "newlineKind": "lf", "apiReport": { "enabled": true, "reportFolder": "api", diff --git a/api/.gitattributes b/api/.gitattributes new file mode 100644 index 00000000..6313b56c --- /dev/null +++ b/api/.gitattributes @@ -0,0 +1 @@ +* text=auto eol=lf diff --git a/api/docs/tough-cookie.cookiejar._constructor_.md b/api/docs/tough-cookie.cookiejar._constructor_.md index 4d1ac506..67e14da5 100644 --- a/api/docs/tough-cookie.cookiejar._constructor_.md +++ b/api/docs/tough-cookie.cookiejar._constructor_.md @@ -1,70 +1,70 @@ - - -[Home](./index.md) > [tough-cookie](./tough-cookie.md) > [CookieJar](./tough-cookie.cookiejar.md) > [(constructor)](./tough-cookie.cookiejar._constructor_.md) - -## CookieJar.(constructor) - -Creates a new `CookieJar` instance. - -**Signature:** - -```typescript -constructor(store?: Nullable, options?: CreateCookieJarOptions | boolean); -``` - -## Parameters - - - - -
- -Parameter - - - - -Type - - - - -Description - - -
- -store - - - - -[Nullable](./tough-cookie.nullable.md)<[Store](./tough-cookie.store.md)> - - - - -_(Optional)_ a custom [Store](./tough-cookie.store.md) implementation (defaults to [MemoryCookieStore](./tough-cookie.memorycookiestore.md)) - - -
- -options - - - - -[CreateCookieJarOptions](./tough-cookie.createcookiejaroptions.md) \| boolean - - - - -_(Optional)_ configures how cookies are processed by the cookie jar - - -
- -## Remarks - -- If a custom store is not passed to the constructor, an in-memory store ([MemoryCookieStore](./tough-cookie.memorycookiestore.md) will be created and used. - If a boolean value is passed as the `options` parameter, this is equivalent to passing `{ rejectPublicSuffixes: }` - + + +[Home](./index.md) > [tough-cookie](./tough-cookie.md) > [CookieJar](./tough-cookie.cookiejar.md) > [(constructor)](./tough-cookie.cookiejar._constructor_.md) + +## CookieJar.(constructor) + +Creates a new `CookieJar` instance. + +**Signature:** + +```typescript +constructor(store?: Nullable, options?: CreateCookieJarOptions | boolean); +``` + +## Parameters + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +store + + + + +[Nullable](./tough-cookie.nullable.md)<[Store](./tough-cookie.store.md)> + + + + +_(Optional)_ a custom [Store](./tough-cookie.store.md) implementation (defaults to [MemoryCookieStore](./tough-cookie.memorycookiestore.md)) + + +
+ +options + + + + +[CreateCookieJarOptions](./tough-cookie.createcookiejaroptions.md) \| boolean + + + + +_(Optional)_ configures how cookies are processed by the cookie jar + + +
+ +## Remarks + +- If a custom store is not passed to the constructor, an in-memory store ([MemoryCookieStore](./tough-cookie.memorycookiestore.md) will be created and used. - If a boolean value is passed as the `options` parameter, this is equivalent to passing `{ rejectPublicSuffixes: }` + diff --git a/api/docs/tough-cookie.cookiejar.clone.md b/api/docs/tough-cookie.cookiejar.clone.md index 146d6587..17fcf457 100644 --- a/api/docs/tough-cookie.cookiejar.clone.md +++ b/api/docs/tough-cookie.cookiejar.clone.md @@ -1,59 +1,59 @@ - - -[Home](./index.md) > [tough-cookie](./tough-cookie.md) > [CookieJar](./tough-cookie.cookiejar.md) > [clone](./tough-cookie.cookiejar.clone.md) - -## CookieJar.clone() method - -Produces a deep clone of this CookieJar. Modifications to the original do not affect the clone, and vice versa. - -**Signature:** - -```typescript -clone(callback: Callback): void; -``` - -## Parameters - - - -
- -Parameter - - - - -Type - - - - -Description - - -
- -callback - - - - -[Callback](./tough-cookie.callback.md)<[CookieJar](./tough-cookie.cookiejar.md)> - - - - -A function to call when the CookieJar is cloned. - - -
-**Returns:** - -void - -## Remarks - -- When no [Store](./tough-cookie.store.md) is provided, a new [MemoryCookieStore](./tough-cookie.memorycookiestore.md) will be used. - -- Transferring between store types is supported so long as the source implements `.getAllCookies()` and the destination implements `.putCookie()`. - + + +[Home](./index.md) > [tough-cookie](./tough-cookie.md) > [CookieJar](./tough-cookie.cookiejar.md) > [clone](./tough-cookie.cookiejar.clone.md) + +## CookieJar.clone() method + +Produces a deep clone of this CookieJar. Modifications to the original do not affect the clone, and vice versa. + +**Signature:** + +```typescript +clone(callback: Callback): void; +``` + +## Parameters + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +callback + + + + +[Callback](./tough-cookie.callback.md)<[CookieJar](./tough-cookie.cookiejar.md)> + + + + +A function to call when the CookieJar is cloned. + + +
+**Returns:** + +void + +## Remarks + +- When no [Store](./tough-cookie.store.md) is provided, a new [MemoryCookieStore](./tough-cookie.memorycookiestore.md) will be used. + +- Transferring between store types is supported so long as the source implements `.getAllCookies()` and the destination implements `.putCookie()`. + diff --git a/api/docs/tough-cookie.cookiejar.clone_1.md b/api/docs/tough-cookie.cookiejar.clone_1.md index 37c7b046..c68b55dd 100644 --- a/api/docs/tough-cookie.cookiejar.clone_1.md +++ b/api/docs/tough-cookie.cookiejar.clone_1.md @@ -1,75 +1,75 @@ - - -[Home](./index.md) > [tough-cookie](./tough-cookie.md) > [CookieJar](./tough-cookie.cookiejar.md) > [clone](./tough-cookie.cookiejar.clone_1.md) - -## CookieJar.clone() method - -Produces a deep clone of this CookieJar. Modifications to the original do not affect the clone, and vice versa. - -**Signature:** - -```typescript -clone(newStore: Store, callback: Callback): void; -``` - -## Parameters - - - - -
- -Parameter - - - - -Type - - - - -Description - - -
- -newStore - - - - -[Store](./tough-cookie.store.md) - - - - -The target [Store](./tough-cookie.store.md) to clone cookies into. - - -
- -callback - - - - -[Callback](./tough-cookie.callback.md)<[CookieJar](./tough-cookie.cookiejar.md)> - - - - -A function to call when the CookieJar is cloned. - - -
-**Returns:** - -void - -## Remarks - -- When no [Store](./tough-cookie.store.md) is provided, a new [MemoryCookieStore](./tough-cookie.memorycookiestore.md) will be used. - -- Transferring between store types is supported so long as the source implements `.getAllCookies()` and the destination implements `.putCookie()`. - + + +[Home](./index.md) > [tough-cookie](./tough-cookie.md) > [CookieJar](./tough-cookie.cookiejar.md) > [clone](./tough-cookie.cookiejar.clone_1.md) + +## CookieJar.clone() method + +Produces a deep clone of this CookieJar. Modifications to the original do not affect the clone, and vice versa. + +**Signature:** + +```typescript +clone(newStore: Store, callback: Callback): void; +``` + +## Parameters + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +newStore + + + + +[Store](./tough-cookie.store.md) + + + + +The target [Store](./tough-cookie.store.md) to clone cookies into. + + +
+ +callback + + + + +[Callback](./tough-cookie.callback.md)<[CookieJar](./tough-cookie.cookiejar.md)> + + + + +A function to call when the CookieJar is cloned. + + +
+**Returns:** + +void + +## Remarks + +- When no [Store](./tough-cookie.store.md) is provided, a new [MemoryCookieStore](./tough-cookie.memorycookiestore.md) will be used. + +- Transferring between store types is supported so long as the source implements `.getAllCookies()` and the destination implements `.putCookie()`. + diff --git a/api/docs/tough-cookie.cookiejar.clone_2.md b/api/docs/tough-cookie.cookiejar.clone_2.md index e68355b4..2d46d2f8 100644 --- a/api/docs/tough-cookie.cookiejar.clone_2.md +++ b/api/docs/tough-cookie.cookiejar.clone_2.md @@ -1,59 +1,59 @@ - - -[Home](./index.md) > [tough-cookie](./tough-cookie.md) > [CookieJar](./tough-cookie.cookiejar.md) > [clone](./tough-cookie.cookiejar.clone_2.md) - -## CookieJar.clone() method - -Produces a deep clone of this CookieJar. Modifications to the original do not affect the clone, and vice versa. - -**Signature:** - -```typescript -clone(newStore?: Store): Promise; -``` - -## Parameters - - - -
- -Parameter - - - - -Type - - - - -Description - - -
- -newStore - - - - -[Store](./tough-cookie.store.md) - - - - -_(Optional)_ The target [Store](./tough-cookie.store.md) to clone cookies into. - - -
-**Returns:** - -Promise<[CookieJar](./tough-cookie.cookiejar.md)> - -## Remarks - -- When no [Store](./tough-cookie.store.md) is provided, a new [MemoryCookieStore](./tough-cookie.memorycookiestore.md) will be used. - -- Transferring between store types is supported so long as the source implements `.getAllCookies()` and the destination implements `.putCookie()`. - + + +[Home](./index.md) > [tough-cookie](./tough-cookie.md) > [CookieJar](./tough-cookie.cookiejar.md) > [clone](./tough-cookie.cookiejar.clone_2.md) + +## CookieJar.clone() method + +Produces a deep clone of this CookieJar. Modifications to the original do not affect the clone, and vice versa. + +**Signature:** + +```typescript +clone(newStore?: Store): Promise; +``` + +## Parameters + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +newStore + + + + +[Store](./tough-cookie.store.md) + + + + +_(Optional)_ The target [Store](./tough-cookie.store.md) to clone cookies into. + + +
+**Returns:** + +Promise<[CookieJar](./tough-cookie.cookiejar.md)> + +## Remarks + +- When no [Store](./tough-cookie.store.md) is provided, a new [MemoryCookieStore](./tough-cookie.memorycookiestore.md) will be used. + +- Transferring between store types is supported so long as the source implements `.getAllCookies()` and the destination implements `.putCookie()`. + diff --git a/api/docs/tough-cookie.cookiejar.clonesync.md b/api/docs/tough-cookie.cookiejar.clonesync.md index 56c65790..7ed8c1ca 100644 --- a/api/docs/tough-cookie.cookiejar.clonesync.md +++ b/api/docs/tough-cookie.cookiejar.clonesync.md @@ -1,61 +1,61 @@ - - -[Home](./index.md) > [tough-cookie](./tough-cookie.md) > [CookieJar](./tough-cookie.cookiejar.md) > [cloneSync](./tough-cookie.cookiejar.clonesync.md) - -## CookieJar.cloneSync() method - -Produces a deep clone of this CookieJar. Modifications to the original do not affect the clone, and vice versa. - -Note: Only works if both the configured Store and destination Store are synchronous. - -**Signature:** - -```typescript -cloneSync(newStore?: Store): CookieJar | undefined; -``` - -## Parameters - - - -
- -Parameter - - - - -Type - - - - -Description - - -
- -newStore - - - - -[Store](./tough-cookie.store.md) - - - - -_(Optional)_ The target [Store](./tough-cookie.store.md) to clone cookies into. - - -
-**Returns:** - -[CookieJar](./tough-cookie.cookiejar.md) \| undefined - -## Remarks - -- When no [Store](./tough-cookie.store.md) is provided, a new [MemoryCookieStore](./tough-cookie.memorycookiestore.md) will be used. - -- Transferring between store types is supported so long as the source implements `.getAllCookies()` and the destination implements `.putCookie()`. - + + +[Home](./index.md) > [tough-cookie](./tough-cookie.md) > [CookieJar](./tough-cookie.cookiejar.md) > [cloneSync](./tough-cookie.cookiejar.clonesync.md) + +## CookieJar.cloneSync() method + +Produces a deep clone of this CookieJar. Modifications to the original do not affect the clone, and vice versa. + +Note: Only works if both the configured Store and destination Store are synchronous. + +**Signature:** + +```typescript +cloneSync(newStore?: Store): CookieJar | undefined; +``` + +## Parameters + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +newStore + + + + +[Store](./tough-cookie.store.md) + + + + +_(Optional)_ The target [Store](./tough-cookie.store.md) to clone cookies into. + + +
+**Returns:** + +[CookieJar](./tough-cookie.cookiejar.md) \| undefined + +## Remarks + +- When no [Store](./tough-cookie.store.md) is provided, a new [MemoryCookieStore](./tough-cookie.memorycookiestore.md) will be used. + +- Transferring between store types is supported so long as the source implements `.getAllCookies()` and the destination implements `.putCookie()`. + diff --git a/api/docs/tough-cookie.cookiejar.deserialize.md b/api/docs/tough-cookie.cookiejar.deserialize.md index 2d0cd0a7..d4e397c2 100644 --- a/api/docs/tough-cookie.cookiejar.deserialize.md +++ b/api/docs/tough-cookie.cookiejar.deserialize.md @@ -1,75 +1,75 @@ - - -[Home](./index.md) > [tough-cookie](./tough-cookie.md) > [CookieJar](./tough-cookie.cookiejar.md) > [deserialize](./tough-cookie.cookiejar.deserialize.md) - -## CookieJar.deserialize() method - -A new CookieJar is created and the serialized [Cookie](./tough-cookie.cookie.md) values are added to the underlying store. Each [Cookie](./tough-cookie.cookie.md) is added via `store.putCookie(...)` in the order in which they appear in the serialization. - -**Signature:** - -```typescript -static deserialize(strOrObj: string | object, callback: Callback): void; -``` - -## Parameters - - - - -
- -Parameter - - - - -Type - - - - -Description - - -
- -strOrObj - - - - -string \| object - - - - -A JSON string or object representing the deserialized cookies. - - -
- -callback - - - - -[Callback](./tough-cookie.callback.md)<[CookieJar](./tough-cookie.cookiejar.md)> - - - - -A function to call after the [CookieJar](./tough-cookie.cookiejar.md) has been deserialized. - - -
-**Returns:** - -void - -## Remarks - -- When no [Store](./tough-cookie.store.md) is provided, a new [MemoryCookieStore](./tough-cookie.memorycookiestore.md) will be used. - -- As a convenience, if `strOrObj` is a string, it is passed through `JSON.parse` first. - + + +[Home](./index.md) > [tough-cookie](./tough-cookie.md) > [CookieJar](./tough-cookie.cookiejar.md) > [deserialize](./tough-cookie.cookiejar.deserialize.md) + +## CookieJar.deserialize() method + +A new CookieJar is created and the serialized [Cookie](./tough-cookie.cookie.md) values are added to the underlying store. Each [Cookie](./tough-cookie.cookie.md) is added via `store.putCookie(...)` in the order in which they appear in the serialization. + +**Signature:** + +```typescript +static deserialize(strOrObj: string | object, callback: Callback): void; +``` + +## Parameters + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +strOrObj + + + + +string \| object + + + + +A JSON string or object representing the deserialized cookies. + + +
+ +callback + + + + +[Callback](./tough-cookie.callback.md)<[CookieJar](./tough-cookie.cookiejar.md)> + + + + +A function to call after the [CookieJar](./tough-cookie.cookiejar.md) has been deserialized. + + +
+**Returns:** + +void + +## Remarks + +- When no [Store](./tough-cookie.store.md) is provided, a new [MemoryCookieStore](./tough-cookie.memorycookiestore.md) will be used. + +- As a convenience, if `strOrObj` is a string, it is passed through `JSON.parse` first. + diff --git a/api/docs/tough-cookie.cookiejar.deserialize_1.md b/api/docs/tough-cookie.cookiejar.deserialize_1.md index a6a511c2..7ee0fced 100644 --- a/api/docs/tough-cookie.cookiejar.deserialize_1.md +++ b/api/docs/tough-cookie.cookiejar.deserialize_1.md @@ -1,91 +1,91 @@ - - -[Home](./index.md) > [tough-cookie](./tough-cookie.md) > [CookieJar](./tough-cookie.cookiejar.md) > [deserialize](./tough-cookie.cookiejar.deserialize_1.md) - -## CookieJar.deserialize() method - -A new CookieJar is created and the serialized [Cookie](./tough-cookie.cookie.md) values are added to the underlying store. Each [Cookie](./tough-cookie.cookie.md) is added via `store.putCookie(...)` in the order in which they appear in the serialization. - -**Signature:** - -```typescript -static deserialize(strOrObj: string | object, store: Store, callback: Callback): void; -``` - -## Parameters - - - - - -
- -Parameter - - - - -Type - - - - -Description - - -
- -strOrObj - - - - -string \| object - - - - -A JSON string or object representing the deserialized cookies. - - -
- -store - - - - -[Store](./tough-cookie.store.md) - - - - -The underlying store to persist the deserialized cookies into. - - -
- -callback - - - - -[Callback](./tough-cookie.callback.md)<[CookieJar](./tough-cookie.cookiejar.md)> - - - - -A function to call after the [CookieJar](./tough-cookie.cookiejar.md) has been deserialized. - - -
-**Returns:** - -void - -## Remarks - -- When no [Store](./tough-cookie.store.md) is provided, a new [MemoryCookieStore](./tough-cookie.memorycookiestore.md) will be used. - -- As a convenience, if `strOrObj` is a string, it is passed through `JSON.parse` first. - + + +[Home](./index.md) > [tough-cookie](./tough-cookie.md) > [CookieJar](./tough-cookie.cookiejar.md) > [deserialize](./tough-cookie.cookiejar.deserialize_1.md) + +## CookieJar.deserialize() method + +A new CookieJar is created and the serialized [Cookie](./tough-cookie.cookie.md) values are added to the underlying store. Each [Cookie](./tough-cookie.cookie.md) is added via `store.putCookie(...)` in the order in which they appear in the serialization. + +**Signature:** + +```typescript +static deserialize(strOrObj: string | object, store: Store, callback: Callback): void; +``` + +## Parameters + + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +strOrObj + + + + +string \| object + + + + +A JSON string or object representing the deserialized cookies. + + +
+ +store + + + + +[Store](./tough-cookie.store.md) + + + + +The underlying store to persist the deserialized cookies into. + + +
+ +callback + + + + +[Callback](./tough-cookie.callback.md)<[CookieJar](./tough-cookie.cookiejar.md)> + + + + +A function to call after the [CookieJar](./tough-cookie.cookiejar.md) has been deserialized. + + +
+**Returns:** + +void + +## Remarks + +- When no [Store](./tough-cookie.store.md) is provided, a new [MemoryCookieStore](./tough-cookie.memorycookiestore.md) will be used. + +- As a convenience, if `strOrObj` is a string, it is passed through `JSON.parse` first. + diff --git a/api/docs/tough-cookie.cookiejar.deserialize_2.md b/api/docs/tough-cookie.cookiejar.deserialize_2.md index d9681680..8272f43b 100644 --- a/api/docs/tough-cookie.cookiejar.deserialize_2.md +++ b/api/docs/tough-cookie.cookiejar.deserialize_2.md @@ -1,75 +1,75 @@ - - -[Home](./index.md) > [tough-cookie](./tough-cookie.md) > [CookieJar](./tough-cookie.cookiejar.md) > [deserialize](./tough-cookie.cookiejar.deserialize_2.md) - -## CookieJar.deserialize() method - -A new CookieJar is created and the serialized [Cookie](./tough-cookie.cookie.md) values are added to the underlying store. Each [Cookie](./tough-cookie.cookie.md) is added via `store.putCookie(...)` in the order in which they appear in the serialization. - -**Signature:** - -```typescript -static deserialize(strOrObj: string | object, store?: Store): Promise; -``` - -## Parameters - - - - -
- -Parameter - - - - -Type - - - - -Description - - -
- -strOrObj - - - - -string \| object - - - - -A JSON string or object representing the deserialized cookies. - - -
- -store - - - - -[Store](./tough-cookie.store.md) - - - - -_(Optional)_ The underlying store to persist the deserialized cookies into. - - -
-**Returns:** - -Promise<[CookieJar](./tough-cookie.cookiejar.md)> - -## Remarks - -- When no [Store](./tough-cookie.store.md) is provided, a new [MemoryCookieStore](./tough-cookie.memorycookiestore.md) will be used. - -- As a convenience, if `strOrObj` is a string, it is passed through `JSON.parse` first. - + + +[Home](./index.md) > [tough-cookie](./tough-cookie.md) > [CookieJar](./tough-cookie.cookiejar.md) > [deserialize](./tough-cookie.cookiejar.deserialize_2.md) + +## CookieJar.deserialize() method + +A new CookieJar is created and the serialized [Cookie](./tough-cookie.cookie.md) values are added to the underlying store. Each [Cookie](./tough-cookie.cookie.md) is added via `store.putCookie(...)` in the order in which they appear in the serialization. + +**Signature:** + +```typescript +static deserialize(strOrObj: string | object, store?: Store): Promise; +``` + +## Parameters + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +strOrObj + + + + +string \| object + + + + +A JSON string or object representing the deserialized cookies. + + +
+ +store + + + + +[Store](./tough-cookie.store.md) + + + + +_(Optional)_ The underlying store to persist the deserialized cookies into. + + +
+**Returns:** + +Promise<[CookieJar](./tough-cookie.cookiejar.md)> + +## Remarks + +- When no [Store](./tough-cookie.store.md) is provided, a new [MemoryCookieStore](./tough-cookie.memorycookiestore.md) will be used. + +- As a convenience, if `strOrObj` is a string, it is passed through `JSON.parse` first. + diff --git a/api/docs/tough-cookie.cookiejar.deserializesync.md b/api/docs/tough-cookie.cookiejar.deserializesync.md index eaf9672b..a7481aaa 100644 --- a/api/docs/tough-cookie.cookiejar.deserializesync.md +++ b/api/docs/tough-cookie.cookiejar.deserializesync.md @@ -1,77 +1,77 @@ - - -[Home](./index.md) > [tough-cookie](./tough-cookie.md) > [CookieJar](./tough-cookie.cookiejar.md) > [deserializeSync](./tough-cookie.cookiejar.deserializesync.md) - -## CookieJar.deserializeSync() method - -A new CookieJar is created and the serialized [Cookie](./tough-cookie.cookie.md) values are added to the underlying store. Each [Cookie](./tough-cookie.cookie.md) is added via `store.putCookie(...)` in the order in which they appear in the serialization. - -Note: Only works if the configured Store is also synchronous. - -**Signature:** - -```typescript -static deserializeSync(strOrObj: string | SerializedCookieJar, store?: Store): CookieJar; -``` - -## Parameters - - - - -
- -Parameter - - - - -Type - - - - -Description - - -
- -strOrObj - - - - -string \| [SerializedCookieJar](./tough-cookie.serializedcookiejar.md) - - - - -A JSON string or object representing the deserialized cookies. - - -
- -store - - - - -[Store](./tough-cookie.store.md) - - - - -_(Optional)_ The underlying store to persist the deserialized cookies into. - - -
-**Returns:** - -[CookieJar](./tough-cookie.cookiejar.md) - -## Remarks - -- When no [Store](./tough-cookie.store.md) is provided, a new [MemoryCookieStore](./tough-cookie.memorycookiestore.md) will be used. - -- As a convenience, if `strOrObj` is a string, it is passed through `JSON.parse` first. - + + +[Home](./index.md) > [tough-cookie](./tough-cookie.md) > [CookieJar](./tough-cookie.cookiejar.md) > [deserializeSync](./tough-cookie.cookiejar.deserializesync.md) + +## CookieJar.deserializeSync() method + +A new CookieJar is created and the serialized [Cookie](./tough-cookie.cookie.md) values are added to the underlying store. Each [Cookie](./tough-cookie.cookie.md) is added via `store.putCookie(...)` in the order in which they appear in the serialization. + +Note: Only works if the configured Store is also synchronous. + +**Signature:** + +```typescript +static deserializeSync(strOrObj: string | SerializedCookieJar, store?: Store): CookieJar; +``` + +## Parameters + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +strOrObj + + + + +string \| [SerializedCookieJar](./tough-cookie.serializedcookiejar.md) + + + + +A JSON string or object representing the deserialized cookies. + + +
+ +store + + + + +[Store](./tough-cookie.store.md) + + + + +_(Optional)_ The underlying store to persist the deserialized cookies into. + + +
+**Returns:** + +[CookieJar](./tough-cookie.cookiejar.md) + +## Remarks + +- When no [Store](./tough-cookie.store.md) is provided, a new [MemoryCookieStore](./tough-cookie.memorycookiestore.md) will be used. + +- As a convenience, if `strOrObj` is a string, it is passed through `JSON.parse` first. + diff --git a/api/docs/tough-cookie.cookiejar.fromjson.md b/api/docs/tough-cookie.cookiejar.fromjson.md index 392f9dfe..63171600 100644 --- a/api/docs/tough-cookie.cookiejar.fromjson.md +++ b/api/docs/tough-cookie.cookiejar.fromjson.md @@ -1,75 +1,75 @@ - - -[Home](./index.md) > [tough-cookie](./tough-cookie.md) > [CookieJar](./tough-cookie.cookiejar.md) > [fromJSON](./tough-cookie.cookiejar.fromjson.md) - -## CookieJar.fromJSON() method - -Alias of [CookieJar.deserializeSync()](./tough-cookie.cookiejar.deserializesync.md). - -**Signature:** - -```typescript -static fromJSON(jsonString: string | SerializedCookieJar, store?: Store): CookieJar; -``` - -## Parameters - - - - -
- -Parameter - - - - -Type - - - - -Description - - -
- -jsonString - - - - -string \| [SerializedCookieJar](./tough-cookie.serializedcookiejar.md) - - - - -A JSON string or object representing the deserialized cookies. - - -
- -store - - - - -[Store](./tough-cookie.store.md) - - - - -_(Optional)_ The underlying store to persist the deserialized cookies into. - - -
-**Returns:** - -[CookieJar](./tough-cookie.cookiejar.md) - -## Remarks - -- When no [Store](./tough-cookie.store.md) is provided, a new [MemoryCookieStore](./tough-cookie.memorycookiestore.md) will be used. - -- As a convenience, if `strOrObj` is a string, it is passed through `JSON.parse` first. - + + +[Home](./index.md) > [tough-cookie](./tough-cookie.md) > [CookieJar](./tough-cookie.cookiejar.md) > [fromJSON](./tough-cookie.cookiejar.fromjson.md) + +## CookieJar.fromJSON() method + +Alias of [CookieJar.deserializeSync()](./tough-cookie.cookiejar.deserializesync.md). + +**Signature:** + +```typescript +static fromJSON(jsonString: string | SerializedCookieJar, store?: Store): CookieJar; +``` + +## Parameters + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +jsonString + + + + +string \| [SerializedCookieJar](./tough-cookie.serializedcookiejar.md) + + + + +A JSON string or object representing the deserialized cookies. + + +
+ +store + + + + +[Store](./tough-cookie.store.md) + + + + +_(Optional)_ The underlying store to persist the deserialized cookies into. + + +
+**Returns:** + +[CookieJar](./tough-cookie.cookiejar.md) + +## Remarks + +- When no [Store](./tough-cookie.store.md) is provided, a new [MemoryCookieStore](./tough-cookie.memorycookiestore.md) will be used. + +- As a convenience, if `strOrObj` is a string, it is passed through `JSON.parse` first. + diff --git a/api/docs/tough-cookie.cookiejar.getcookies.md b/api/docs/tough-cookie.cookiejar.getcookies.md index de27d146..512f80a4 100644 --- a/api/docs/tough-cookie.cookiejar.getcookies.md +++ b/api/docs/tough-cookie.cookiejar.getcookies.md @@ -1,75 +1,75 @@ - - -[Home](./index.md) > [tough-cookie](./tough-cookie.md) > [CookieJar](./tough-cookie.cookiejar.md) > [getCookies](./tough-cookie.cookiejar.getcookies.md) - -## CookieJar.getCookies() method - -Retrieve the list of cookies that can be sent in a Cookie header for the current URL. - -**Signature:** - -```typescript -getCookies(url: string, callback: Callback): void; -``` - -## Parameters - - - - -
- -Parameter - - - - -Type - - - - -Description - - -
- -url - - - - -string - - - - -The domain to store the cookie with. - - -
- -callback - - - - -[Callback](./tough-cookie.callback.md)<[Cookie](./tough-cookie.cookie.md)\[\]> - - - - -A function to call after a cookie has been successfully retrieved. - - -
-**Returns:** - -void - -## Remarks - -- The array of cookies returned will be sorted according to [cookieCompare()](./tough-cookie.cookiecompare.md). - -- The [Cookie.lastAccessed](./tough-cookie.cookie.lastaccessed.md) property will be updated on all returned cookies. - + + +[Home](./index.md) > [tough-cookie](./tough-cookie.md) > [CookieJar](./tough-cookie.cookiejar.md) > [getCookies](./tough-cookie.cookiejar.getcookies.md) + +## CookieJar.getCookies() method + +Retrieve the list of cookies that can be sent in a Cookie header for the current URL. + +**Signature:** + +```typescript +getCookies(url: string, callback: Callback): void; +``` + +## Parameters + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +url + + + + +string + + + + +The domain to store the cookie with. + + +
+ +callback + + + + +[Callback](./tough-cookie.callback.md)<[Cookie](./tough-cookie.cookie.md)\[\]> + + + + +A function to call after a cookie has been successfully retrieved. + + +
+**Returns:** + +void + +## Remarks + +- The array of cookies returned will be sorted according to [cookieCompare()](./tough-cookie.cookiecompare.md). + +- The [Cookie.lastAccessed](./tough-cookie.cookie.lastaccessed.md) property will be updated on all returned cookies. + diff --git a/api/docs/tough-cookie.cookiejar.getcookies_1.md b/api/docs/tough-cookie.cookiejar.getcookies_1.md index 86ed9c93..f842189f 100644 --- a/api/docs/tough-cookie.cookiejar.getcookies_1.md +++ b/api/docs/tough-cookie.cookiejar.getcookies_1.md @@ -1,91 +1,91 @@ - - -[Home](./index.md) > [tough-cookie](./tough-cookie.md) > [CookieJar](./tough-cookie.cookiejar.md) > [getCookies](./tough-cookie.cookiejar.getcookies_1.md) - -## CookieJar.getCookies() method - -Retrieve the list of cookies that can be sent in a Cookie header for the current URL. - -**Signature:** - -```typescript -getCookies(url: string | URL, options: GetCookiesOptions | undefined, callback: Callback): void; -``` - -## Parameters - - - - - -
- -Parameter - - - - -Type - - - - -Description - - -
- -url - - - - -string \| URL - - - - -The domain to store the cookie with. - - -
- -options - - - - -[GetCookiesOptions](./tough-cookie.getcookiesoptions.md) \| undefined - - - - -Configuration settings to use when retrieving the cookies. - - -
- -callback - - - - -[Callback](./tough-cookie.callback.md)<[Cookie](./tough-cookie.cookie.md)\[\]> - - - - -A function to call after a cookie has been successfully retrieved. - - -
-**Returns:** - -void - -## Remarks - -- The array of cookies returned will be sorted according to [cookieCompare()](./tough-cookie.cookiecompare.md). - -- The [Cookie.lastAccessed](./tough-cookie.cookie.lastaccessed.md) property will be updated on all returned cookies. - + + +[Home](./index.md) > [tough-cookie](./tough-cookie.md) > [CookieJar](./tough-cookie.cookiejar.md) > [getCookies](./tough-cookie.cookiejar.getcookies_1.md) + +## CookieJar.getCookies() method + +Retrieve the list of cookies that can be sent in a Cookie header for the current URL. + +**Signature:** + +```typescript +getCookies(url: string | URL, options: GetCookiesOptions | undefined, callback: Callback): void; +``` + +## Parameters + + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +url + + + + +string \| URL + + + + +The domain to store the cookie with. + + +
+ +options + + + + +[GetCookiesOptions](./tough-cookie.getcookiesoptions.md) \| undefined + + + + +Configuration settings to use when retrieving the cookies. + + +
+ +callback + + + + +[Callback](./tough-cookie.callback.md)<[Cookie](./tough-cookie.cookie.md)\[\]> + + + + +A function to call after a cookie has been successfully retrieved. + + +
+**Returns:** + +void + +## Remarks + +- The array of cookies returned will be sorted according to [cookieCompare()](./tough-cookie.cookiecompare.md). + +- The [Cookie.lastAccessed](./tough-cookie.cookie.lastaccessed.md) property will be updated on all returned cookies. + diff --git a/api/docs/tough-cookie.cookiejar.getcookies_2.md b/api/docs/tough-cookie.cookiejar.getcookies_2.md index 05266bd4..760ce4d2 100644 --- a/api/docs/tough-cookie.cookiejar.getcookies_2.md +++ b/api/docs/tough-cookie.cookiejar.getcookies_2.md @@ -1,75 +1,75 @@ - - -[Home](./index.md) > [tough-cookie](./tough-cookie.md) > [CookieJar](./tough-cookie.cookiejar.md) > [getCookies](./tough-cookie.cookiejar.getcookies_2.md) - -## CookieJar.getCookies() method - -Retrieve the list of cookies that can be sent in a Cookie header for the current URL. - -**Signature:** - -```typescript -getCookies(url: string | URL, options?: GetCookiesOptions | undefined): Promise; -``` - -## Parameters - - - - -
- -Parameter - - - - -Type - - - - -Description - - -
- -url - - - - -string \| URL - - - - -The domain to store the cookie with. - - -
- -options - - - - -[GetCookiesOptions](./tough-cookie.getcookiesoptions.md) \| undefined - - - - -_(Optional)_ Configuration settings to use when retrieving the cookies. - - -
-**Returns:** - -Promise<[Cookie](./tough-cookie.cookie.md)\[\]> - -## Remarks - -- The array of cookies returned will be sorted according to [cookieCompare()](./tough-cookie.cookiecompare.md). - -- The [Cookie.lastAccessed](./tough-cookie.cookie.lastaccessed.md) property will be updated on all returned cookies. - + + +[Home](./index.md) > [tough-cookie](./tough-cookie.md) > [CookieJar](./tough-cookie.cookiejar.md) > [getCookies](./tough-cookie.cookiejar.getcookies_2.md) + +## CookieJar.getCookies() method + +Retrieve the list of cookies that can be sent in a Cookie header for the current URL. + +**Signature:** + +```typescript +getCookies(url: string | URL, options?: GetCookiesOptions | undefined): Promise; +``` + +## Parameters + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +url + + + + +string \| URL + + + + +The domain to store the cookie with. + + +
+ +options + + + + +[GetCookiesOptions](./tough-cookie.getcookiesoptions.md) \| undefined + + + + +_(Optional)_ Configuration settings to use when retrieving the cookies. + + +
+**Returns:** + +Promise<[Cookie](./tough-cookie.cookie.md)\[\]> + +## Remarks + +- The array of cookies returned will be sorted according to [cookieCompare()](./tough-cookie.cookiecompare.md). + +- The [Cookie.lastAccessed](./tough-cookie.cookie.lastaccessed.md) property will be updated on all returned cookies. + diff --git a/api/docs/tough-cookie.cookiejar.getcookiessync.md b/api/docs/tough-cookie.cookiejar.getcookiessync.md index 08bb6721..fdb3e2ef 100644 --- a/api/docs/tough-cookie.cookiejar.getcookiessync.md +++ b/api/docs/tough-cookie.cookiejar.getcookiessync.md @@ -1,77 +1,77 @@ - - -[Home](./index.md) > [tough-cookie](./tough-cookie.md) > [CookieJar](./tough-cookie.cookiejar.md) > [getCookiesSync](./tough-cookie.cookiejar.getcookiessync.md) - -## CookieJar.getCookiesSync() method - -Synchronously retrieve the list of cookies that can be sent in a Cookie header for the current URL. - -Note: Only works if the configured Store is also synchronous. - -**Signature:** - -```typescript -getCookiesSync(url: string, options?: GetCookiesOptions): Cookie[]; -``` - -## Parameters - - - - -
- -Parameter - - - - -Type - - - - -Description - - -
- -url - - - - -string - - - - -The domain to store the cookie with. - - -
- -options - - - - -[GetCookiesOptions](./tough-cookie.getcookiesoptions.md) - - - - -_(Optional)_ Configuration settings to use when retrieving the cookies. - - -
-**Returns:** - -[Cookie](./tough-cookie.cookie.md)\[\] - -## Remarks - -- The array of cookies returned will be sorted according to [cookieCompare()](./tough-cookie.cookiecompare.md). - -- The [Cookie.lastAccessed](./tough-cookie.cookie.lastaccessed.md) property will be updated on all returned cookies. - + + +[Home](./index.md) > [tough-cookie](./tough-cookie.md) > [CookieJar](./tough-cookie.cookiejar.md) > [getCookiesSync](./tough-cookie.cookiejar.getcookiessync.md) + +## CookieJar.getCookiesSync() method + +Synchronously retrieve the list of cookies that can be sent in a Cookie header for the current URL. + +Note: Only works if the configured Store is also synchronous. + +**Signature:** + +```typescript +getCookiesSync(url: string, options?: GetCookiesOptions): Cookie[]; +``` + +## Parameters + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +url + + + + +string + + + + +The domain to store the cookie with. + + +
+ +options + + + + +[GetCookiesOptions](./tough-cookie.getcookiesoptions.md) + + + + +_(Optional)_ Configuration settings to use when retrieving the cookies. + + +
+**Returns:** + +[Cookie](./tough-cookie.cookie.md)\[\] + +## Remarks + +- The array of cookies returned will be sorted according to [cookieCompare()](./tough-cookie.cookiecompare.md). + +- The [Cookie.lastAccessed](./tough-cookie.cookie.lastaccessed.md) property will be updated on all returned cookies. + diff --git a/api/docs/tough-cookie.cookiejar.getcookiestring.md b/api/docs/tough-cookie.cookiejar.getcookiestring.md index 57ead58e..b2241ab5 100644 --- a/api/docs/tough-cookie.cookiejar.getcookiestring.md +++ b/api/docs/tough-cookie.cookiejar.getcookiestring.md @@ -1,85 +1,85 @@ - - -[Home](./index.md) > [tough-cookie](./tough-cookie.md) > [CookieJar](./tough-cookie.cookiejar.md) > [getCookieString](./tough-cookie.cookiejar.getcookiestring.md) - -## CookieJar.getCookieString() method - -Accepts the same options as `.getCookies()` but returns a string suitable for a `Cookie` header rather than an Array. - -**Signature:** - -```typescript -getCookieString(url: string, options: GetCookiesOptions, callback: Callback): void; -``` - -## Parameters - - - - - -
- -Parameter - - - - -Type - - - - -Description - - -
- -url - - - - -string - - - - -The domain to store the cookie with. - - -
- -options - - - - -[GetCookiesOptions](./tough-cookie.getcookiesoptions.md) - - - - -Configuration settings to use when retrieving the cookies. - - -
- -callback - - - - -[Callback](./tough-cookie.callback.md)<string \| undefined> - - - - -A function to call after the `Cookie` header string has been created. - - -
-**Returns:** - -void - + + +[Home](./index.md) > [tough-cookie](./tough-cookie.md) > [CookieJar](./tough-cookie.cookiejar.md) > [getCookieString](./tough-cookie.cookiejar.getcookiestring.md) + +## CookieJar.getCookieString() method + +Accepts the same options as `.getCookies()` but returns a string suitable for a `Cookie` header rather than an Array. + +**Signature:** + +```typescript +getCookieString(url: string, options: GetCookiesOptions, callback: Callback): void; +``` + +## Parameters + + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +url + + + + +string + + + + +The domain to store the cookie with. + + +
+ +options + + + + +[GetCookiesOptions](./tough-cookie.getcookiesoptions.md) + + + + +Configuration settings to use when retrieving the cookies. + + +
+ +callback + + + + +[Callback](./tough-cookie.callback.md)<string \| undefined> + + + + +A function to call after the `Cookie` header string has been created. + + +
+**Returns:** + +void + diff --git a/api/docs/tough-cookie.cookiejar.getcookiestring_1.md b/api/docs/tough-cookie.cookiejar.getcookiestring_1.md index bbbb4acf..0fd33009 100644 --- a/api/docs/tough-cookie.cookiejar.getcookiestring_1.md +++ b/api/docs/tough-cookie.cookiejar.getcookiestring_1.md @@ -1,69 +1,69 @@ - - -[Home](./index.md) > [tough-cookie](./tough-cookie.md) > [CookieJar](./tough-cookie.cookiejar.md) > [getCookieString](./tough-cookie.cookiejar.getcookiestring_1.md) - -## CookieJar.getCookieString() method - -Accepts the same options as `.getCookies()` but returns a string suitable for a `Cookie` header rather than an Array. - -**Signature:** - -```typescript -getCookieString(url: string, callback: Callback): void; -``` - -## Parameters - - - - -
- -Parameter - - - - -Type - - - - -Description - - -
- -url - - - - -string - - - - -The domain to store the cookie with. - - -
- -callback - - - - -[Callback](./tough-cookie.callback.md)<string \| undefined> - - - - -A function to call after the `Cookie` header string has been created. - - -
-**Returns:** - -void - + + +[Home](./index.md) > [tough-cookie](./tough-cookie.md) > [CookieJar](./tough-cookie.cookiejar.md) > [getCookieString](./tough-cookie.cookiejar.getcookiestring_1.md) + +## CookieJar.getCookieString() method + +Accepts the same options as `.getCookies()` but returns a string suitable for a `Cookie` header rather than an Array. + +**Signature:** + +```typescript +getCookieString(url: string, callback: Callback): void; +``` + +## Parameters + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +url + + + + +string + + + + +The domain to store the cookie with. + + +
+ +callback + + + + +[Callback](./tough-cookie.callback.md)<string \| undefined> + + + + +A function to call after the `Cookie` header string has been created. + + +
+**Returns:** + +void + diff --git a/api/docs/tough-cookie.cookiejar.getcookiestring_2.md b/api/docs/tough-cookie.cookiejar.getcookiestring_2.md index 89ddad87..936c72c1 100644 --- a/api/docs/tough-cookie.cookiejar.getcookiestring_2.md +++ b/api/docs/tough-cookie.cookiejar.getcookiestring_2.md @@ -1,69 +1,69 @@ - - -[Home](./index.md) > [tough-cookie](./tough-cookie.md) > [CookieJar](./tough-cookie.cookiejar.md) > [getCookieString](./tough-cookie.cookiejar.getcookiestring_2.md) - -## CookieJar.getCookieString() method - -Accepts the same options as `.getCookies()` but returns a string suitable for a `Cookie` header rather than an Array. - -**Signature:** - -```typescript -getCookieString(url: string, options?: GetCookiesOptions): Promise; -``` - -## Parameters - - - - -
- -Parameter - - - - -Type - - - - -Description - - -
- -url - - - - -string - - - - -The domain to store the cookie with. - - -
- -options - - - - -[GetCookiesOptions](./tough-cookie.getcookiesoptions.md) - - - - -_(Optional)_ Configuration settings to use when retrieving the cookies. - - -
-**Returns:** - -Promise<string> - + + +[Home](./index.md) > [tough-cookie](./tough-cookie.md) > [CookieJar](./tough-cookie.cookiejar.md) > [getCookieString](./tough-cookie.cookiejar.getcookiestring_2.md) + +## CookieJar.getCookieString() method + +Accepts the same options as `.getCookies()` but returns a string suitable for a `Cookie` header rather than an Array. + +**Signature:** + +```typescript +getCookieString(url: string, options?: GetCookiesOptions): Promise; +``` + +## Parameters + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +url + + + + +string + + + + +The domain to store the cookie with. + + +
+ +options + + + + +[GetCookiesOptions](./tough-cookie.getcookiesoptions.md) + + + + +_(Optional)_ Configuration settings to use when retrieving the cookies. + + +
+**Returns:** + +Promise<string> + diff --git a/api/docs/tough-cookie.cookiejar.getcookiestringsync.md b/api/docs/tough-cookie.cookiejar.getcookiestringsync.md index 7c866eb9..b79682cb 100644 --- a/api/docs/tough-cookie.cookiejar.getcookiestringsync.md +++ b/api/docs/tough-cookie.cookiejar.getcookiestringsync.md @@ -1,71 +1,71 @@ - - -[Home](./index.md) > [tough-cookie](./tough-cookie.md) > [CookieJar](./tough-cookie.cookiejar.md) > [getCookieStringSync](./tough-cookie.cookiejar.getcookiestringsync.md) - -## CookieJar.getCookieStringSync() method - -Synchronous version of `.getCookieString()`. Accepts the same options as `.getCookies()` but returns a string suitable for a `Cookie` header rather than an Array. - -Note: Only works if the configured Store is also synchronous. - -**Signature:** - -```typescript -getCookieStringSync(url: string, options?: GetCookiesOptions): string; -``` - -## Parameters - - - - -
- -Parameter - - - - -Type - - - - -Description - - -
- -url - - - - -string - - - - -The domain to store the cookie with. - - -
- -options - - - - -[GetCookiesOptions](./tough-cookie.getcookiesoptions.md) - - - - -_(Optional)_ Configuration settings to use when retrieving the cookies. - - -
-**Returns:** - -string - + + +[Home](./index.md) > [tough-cookie](./tough-cookie.md) > [CookieJar](./tough-cookie.cookiejar.md) > [getCookieStringSync](./tough-cookie.cookiejar.getcookiestringsync.md) + +## CookieJar.getCookieStringSync() method + +Synchronous version of `.getCookieString()`. Accepts the same options as `.getCookies()` but returns a string suitable for a `Cookie` header rather than an Array. + +Note: Only works if the configured Store is also synchronous. + +**Signature:** + +```typescript +getCookieStringSync(url: string, options?: GetCookiesOptions): string; +``` + +## Parameters + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +url + + + + +string + + + + +The domain to store the cookie with. + + +
+ +options + + + + +[GetCookiesOptions](./tough-cookie.getcookiesoptions.md) + + + + +_(Optional)_ Configuration settings to use when retrieving the cookies. + + +
+**Returns:** + +string + diff --git a/api/docs/tough-cookie.cookiejar.getsetcookiestrings.md b/api/docs/tough-cookie.cookiejar.getsetcookiestrings.md index 8345786a..843c05c2 100644 --- a/api/docs/tough-cookie.cookiejar.getsetcookiestrings.md +++ b/api/docs/tough-cookie.cookiejar.getsetcookiestrings.md @@ -1,69 +1,69 @@ - - -[Home](./index.md) > [tough-cookie](./tough-cookie.md) > [CookieJar](./tough-cookie.cookiejar.md) > [getSetCookieStrings](./tough-cookie.cookiejar.getsetcookiestrings.md) - -## CookieJar.getSetCookieStrings() method - -Returns an array of strings suitable for `Set-Cookie` headers. Accepts the same options as `.getCookies()`. - -**Signature:** - -```typescript -getSetCookieStrings(url: string, callback: Callback): void; -``` - -## Parameters - - - - -
- -Parameter - - - - -Type - - - - -Description - - -
- -url - - - - -string - - - - -The domain to store the cookie with. - - -
- -callback - - - - -[Callback](./tough-cookie.callback.md)<string\[\] \| undefined> - - - - -A function to call after the `Set-Cookie` header strings have been created. - - -
-**Returns:** - -void - + + +[Home](./index.md) > [tough-cookie](./tough-cookie.md) > [CookieJar](./tough-cookie.cookiejar.md) > [getSetCookieStrings](./tough-cookie.cookiejar.getsetcookiestrings.md) + +## CookieJar.getSetCookieStrings() method + +Returns an array of strings suitable for `Set-Cookie` headers. Accepts the same options as `.getCookies()`. + +**Signature:** + +```typescript +getSetCookieStrings(url: string, callback: Callback): void; +``` + +## Parameters + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +url + + + + +string + + + + +The domain to store the cookie with. + + +
+ +callback + + + + +[Callback](./tough-cookie.callback.md)<string\[\] \| undefined> + + + + +A function to call after the `Set-Cookie` header strings have been created. + + +
+**Returns:** + +void + diff --git a/api/docs/tough-cookie.cookiejar.getsetcookiestrings_1.md b/api/docs/tough-cookie.cookiejar.getsetcookiestrings_1.md index d5c0a5e4..5e7ecab1 100644 --- a/api/docs/tough-cookie.cookiejar.getsetcookiestrings_1.md +++ b/api/docs/tough-cookie.cookiejar.getsetcookiestrings_1.md @@ -1,85 +1,85 @@ - - -[Home](./index.md) > [tough-cookie](./tough-cookie.md) > [CookieJar](./tough-cookie.cookiejar.md) > [getSetCookieStrings](./tough-cookie.cookiejar.getsetcookiestrings_1.md) - -## CookieJar.getSetCookieStrings() method - -Returns an array of strings suitable for `Set-Cookie` headers. Accepts the same options as `.getCookies()`. - -**Signature:** - -```typescript -getSetCookieStrings(url: string, options: GetCookiesOptions, callback: Callback): void; -``` - -## Parameters - - - - - -
- -Parameter - - - - -Type - - - - -Description - - -
- -url - - - - -string - - - - -The domain to store the cookie with. - - -
- -options - - - - -[GetCookiesOptions](./tough-cookie.getcookiesoptions.md) - - - - -Configuration settings to use when retrieving the cookies. - - -
- -callback - - - - -[Callback](./tough-cookie.callback.md)<string\[\] \| undefined> - - - - -A function to call after the `Set-Cookie` header strings have been created. - - -
-**Returns:** - -void - + + +[Home](./index.md) > [tough-cookie](./tough-cookie.md) > [CookieJar](./tough-cookie.cookiejar.md) > [getSetCookieStrings](./tough-cookie.cookiejar.getsetcookiestrings_1.md) + +## CookieJar.getSetCookieStrings() method + +Returns an array of strings suitable for `Set-Cookie` headers. Accepts the same options as `.getCookies()`. + +**Signature:** + +```typescript +getSetCookieStrings(url: string, options: GetCookiesOptions, callback: Callback): void; +``` + +## Parameters + + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +url + + + + +string + + + + +The domain to store the cookie with. + + +
+ +options + + + + +[GetCookiesOptions](./tough-cookie.getcookiesoptions.md) + + + + +Configuration settings to use when retrieving the cookies. + + +
+ +callback + + + + +[Callback](./tough-cookie.callback.md)<string\[\] \| undefined> + + + + +A function to call after the `Set-Cookie` header strings have been created. + + +
+**Returns:** + +void + diff --git a/api/docs/tough-cookie.cookiejar.getsetcookiestrings_2.md b/api/docs/tough-cookie.cookiejar.getsetcookiestrings_2.md index 3a547cc3..6fb97b52 100644 --- a/api/docs/tough-cookie.cookiejar.getsetcookiestrings_2.md +++ b/api/docs/tough-cookie.cookiejar.getsetcookiestrings_2.md @@ -1,69 +1,69 @@ - - -[Home](./index.md) > [tough-cookie](./tough-cookie.md) > [CookieJar](./tough-cookie.cookiejar.md) > [getSetCookieStrings](./tough-cookie.cookiejar.getsetcookiestrings_2.md) - -## CookieJar.getSetCookieStrings() method - -Returns an array of strings suitable for `Set-Cookie` headers. Accepts the same options as `.getCookies()`. - -**Signature:** - -```typescript -getSetCookieStrings(url: string, options?: GetCookiesOptions): Promise; -``` - -## Parameters - - - - -
- -Parameter - - - - -Type - - - - -Description - - -
- -url - - - - -string - - - - -The domain to store the cookie with. - - -
- -options - - - - -[GetCookiesOptions](./tough-cookie.getcookiesoptions.md) - - - - -_(Optional)_ Configuration settings to use when retrieving the cookies. - - -
-**Returns:** - -Promise<string\[\] \| undefined> - + + +[Home](./index.md) > [tough-cookie](./tough-cookie.md) > [CookieJar](./tough-cookie.cookiejar.md) > [getSetCookieStrings](./tough-cookie.cookiejar.getsetcookiestrings_2.md) + +## CookieJar.getSetCookieStrings() method + +Returns an array of strings suitable for `Set-Cookie` headers. Accepts the same options as `.getCookies()`. + +**Signature:** + +```typescript +getSetCookieStrings(url: string, options?: GetCookiesOptions): Promise; +``` + +## Parameters + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +url + + + + +string + + + + +The domain to store the cookie with. + + +
+ +options + + + + +[GetCookiesOptions](./tough-cookie.getcookiesoptions.md) + + + + +_(Optional)_ Configuration settings to use when retrieving the cookies. + + +
+**Returns:** + +Promise<string\[\] \| undefined> + diff --git a/api/docs/tough-cookie.cookiejar.getsetcookiestringssync.md b/api/docs/tough-cookie.cookiejar.getsetcookiestringssync.md index 5f48f880..1f0c6d53 100644 --- a/api/docs/tough-cookie.cookiejar.getsetcookiestringssync.md +++ b/api/docs/tough-cookie.cookiejar.getsetcookiestringssync.md @@ -1,71 +1,71 @@ - - -[Home](./index.md) > [tough-cookie](./tough-cookie.md) > [CookieJar](./tough-cookie.cookiejar.md) > [getSetCookieStringsSync](./tough-cookie.cookiejar.getsetcookiestringssync.md) - -## CookieJar.getSetCookieStringsSync() method - -Synchronous version of `.getSetCookieStrings()`. Returns an array of strings suitable for `Set-Cookie` headers. Accepts the same options as `.getCookies()`. - -Note: Only works if the configured Store is also synchronous. - -**Signature:** - -```typescript -getSetCookieStringsSync(url: string, options?: GetCookiesOptions): string[]; -``` - -## Parameters - - - - -
- -Parameter - - - - -Type - - - - -Description - - -
- -url - - - - -string - - - - -The domain to store the cookie with. - - -
- -options - - - - -[GetCookiesOptions](./tough-cookie.getcookiesoptions.md) - - - - -_(Optional)_ Configuration settings to use when retrieving the cookies. - - -
-**Returns:** - -string\[\] - + + +[Home](./index.md) > [tough-cookie](./tough-cookie.md) > [CookieJar](./tough-cookie.cookiejar.md) > [getSetCookieStringsSync](./tough-cookie.cookiejar.getsetcookiestringssync.md) + +## CookieJar.getSetCookieStringsSync() method + +Synchronous version of `.getSetCookieStrings()`. Returns an array of strings suitable for `Set-Cookie` headers. Accepts the same options as `.getCookies()`. + +Note: Only works if the configured Store is also synchronous. + +**Signature:** + +```typescript +getSetCookieStringsSync(url: string, options?: GetCookiesOptions): string[]; +``` + +## Parameters + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +url + + + + +string + + + + +The domain to store the cookie with. + + +
+ +options + + + + +[GetCookiesOptions](./tough-cookie.getcookiesoptions.md) + + + + +_(Optional)_ Configuration settings to use when retrieving the cookies. + + +
+**Returns:** + +string\[\] + diff --git a/api/docs/tough-cookie.cookiejar.md b/api/docs/tough-cookie.cookiejar.md index ed5c5967..57a132d0 100644 --- a/api/docs/tough-cookie.cookiejar.md +++ b/api/docs/tough-cookie.cookiejar.md @@ -1,610 +1,610 @@ - - -[Home](./index.md) > [tough-cookie](./tough-cookie.md) > [CookieJar](./tough-cookie.cookiejar.md) - -## CookieJar class - -A CookieJar is for storage and retrieval of [Cookie](./tough-cookie.cookie.md) objects as defined in [RFC6265 - Section 5.3](https://www.rfc-editor.org/rfc/rfc6265.html#section-5.3). - -It also supports a pluggable persistence layer via [Store](./tough-cookie.store.md). - -**Signature:** - -```typescript -export declare class CookieJar -``` - -## Constructors - - - -
- -Constructor - - - - -Modifiers - - - - -Description - - -
- -[(constructor)(store, options)](./tough-cookie.cookiejar._constructor_.md) - - - - - - - -Creates a new `CookieJar` instance. - - -
- -## Properties - - - - -
- -Property - - - - -Modifiers - - - - -Type - - - - -Description - - -
- -[prefixSecurity](./tough-cookie.cookiejar.prefixsecurity.md) - - - - -`readonly` - - - - -string - - - - -The configured [PrefixSecurityEnum](./tough-cookie.prefixsecurityenum.md) value for the [CookieJar](./tough-cookie.cookiejar.md). - - -
- -[store](./tough-cookie.cookiejar.store.md) - - - - -`readonly` - - - - -[Store](./tough-cookie.store.md) - - - - -The configured [Store](./tough-cookie.store.md) for the [CookieJar](./tough-cookie.cookiejar.md). - - -
- -## Methods - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Method - - - - -Modifiers - - - - -Description - - -
- -[clone(callback)](./tough-cookie.cookiejar.clone.md) - - - - - - - -Produces a deep clone of this CookieJar. Modifications to the original do not affect the clone, and vice versa. - - -
- -[clone(newStore, callback)](./tough-cookie.cookiejar.clone_1.md) - - - - - - - -Produces a deep clone of this CookieJar. Modifications to the original do not affect the clone, and vice versa. - - -
- -[clone(newStore)](./tough-cookie.cookiejar.clone_2.md) - - - - - - - -Produces a deep clone of this CookieJar. Modifications to the original do not affect the clone, and vice versa. - - -
- -[cloneSync(newStore)](./tough-cookie.cookiejar.clonesync.md) - - - - - - - -Produces a deep clone of this CookieJar. Modifications to the original do not affect the clone, and vice versa. - -Note: Only works if both the configured Store and destination Store are synchronous. - - -
- -[deserialize(strOrObj, callback)](./tough-cookie.cookiejar.deserialize.md) - - - - -`static` - - - - -A new CookieJar is created and the serialized [Cookie](./tough-cookie.cookie.md) values are added to the underlying store. Each [Cookie](./tough-cookie.cookie.md) is added via `store.putCookie(...)` in the order in which they appear in the serialization. - - -
- -[deserialize(strOrObj, store, callback)](./tough-cookie.cookiejar.deserialize_1.md) - - - - -`static` - - - - -A new CookieJar is created and the serialized [Cookie](./tough-cookie.cookie.md) values are added to the underlying store. Each [Cookie](./tough-cookie.cookie.md) is added via `store.putCookie(...)` in the order in which they appear in the serialization. - - -
- -[deserialize(strOrObj, store)](./tough-cookie.cookiejar.deserialize_2.md) - - - - -`static` - - - - -A new CookieJar is created and the serialized [Cookie](./tough-cookie.cookie.md) values are added to the underlying store. Each [Cookie](./tough-cookie.cookie.md) is added via `store.putCookie(...)` in the order in which they appear in the serialization. - - -
- -[deserializeSync(strOrObj, store)](./tough-cookie.cookiejar.deserializesync.md) - - - - -`static` - - - - -A new CookieJar is created and the serialized [Cookie](./tough-cookie.cookie.md) values are added to the underlying store. Each [Cookie](./tough-cookie.cookie.md) is added via `store.putCookie(...)` in the order in which they appear in the serialization. - -Note: Only works if the configured Store is also synchronous. - - -
- -[fromJSON(jsonString, store)](./tough-cookie.cookiejar.fromjson.md) - - - - -`static` - - - - -Alias of [CookieJar.deserializeSync()](./tough-cookie.cookiejar.deserializesync.md). - - -
- -[getCookies(url, callback)](./tough-cookie.cookiejar.getcookies.md) - - - - - - - -Retrieve the list of cookies that can be sent in a Cookie header for the current URL. - - -
- -[getCookies(url, options, callback)](./tough-cookie.cookiejar.getcookies_1.md) - - - - - - - -Retrieve the list of cookies that can be sent in a Cookie header for the current URL. - - -
- -[getCookies(url, options)](./tough-cookie.cookiejar.getcookies_2.md) - - - - - - - -Retrieve the list of cookies that can be sent in a Cookie header for the current URL. - - -
- -[getCookiesSync(url, options)](./tough-cookie.cookiejar.getcookiessync.md) - - - - - - - -Synchronously retrieve the list of cookies that can be sent in a Cookie header for the current URL. - -Note: Only works if the configured Store is also synchronous. - - -
- -[getCookieString(url, options, callback)](./tough-cookie.cookiejar.getcookiestring.md) - - - - - - - -Accepts the same options as `.getCookies()` but returns a string suitable for a `Cookie` header rather than an Array. - - -
- -[getCookieString(url, callback)](./tough-cookie.cookiejar.getcookiestring_1.md) - - - - - - - -Accepts the same options as `.getCookies()` but returns a string suitable for a `Cookie` header rather than an Array. - - -
- -[getCookieString(url, options)](./tough-cookie.cookiejar.getcookiestring_2.md) - - - - - - - -Accepts the same options as `.getCookies()` but returns a string suitable for a `Cookie` header rather than an Array. - - -
- -[getCookieStringSync(url, options)](./tough-cookie.cookiejar.getcookiestringsync.md) - - - - - - - -Synchronous version of `.getCookieString()`. Accepts the same options as `.getCookies()` but returns a string suitable for a `Cookie` header rather than an Array. - -Note: Only works if the configured Store is also synchronous. - - -
- -[getSetCookieStrings(url, callback)](./tough-cookie.cookiejar.getsetcookiestrings.md) - - - - - - - -Returns an array of strings suitable for `Set-Cookie` headers. Accepts the same options as `.getCookies()`. - - -
- -[getSetCookieStrings(url, options, callback)](./tough-cookie.cookiejar.getsetcookiestrings_1.md) - - - - - - - -Returns an array of strings suitable for `Set-Cookie` headers. Accepts the same options as `.getCookies()`. - - -
- -[getSetCookieStrings(url, options)](./tough-cookie.cookiejar.getsetcookiestrings_2.md) - - - - - - - -Returns an array of strings suitable for `Set-Cookie` headers. Accepts the same options as `.getCookies()`. - - -
- -[getSetCookieStringsSync(url, options)](./tough-cookie.cookiejar.getsetcookiestringssync.md) - - - - - - - -Synchronous version of `.getSetCookieStrings()`. Returns an array of strings suitable for `Set-Cookie` headers. Accepts the same options as `.getCookies()`. - -Note: Only works if the configured Store is also synchronous. - - -
- -[removeAllCookies(callback)](./tough-cookie.cookiejar.removeallcookies.md) - - - - - - - -Removes all cookies from the CookieJar. - - -
- -[removeAllCookies()](./tough-cookie.cookiejar.removeallcookies_1.md) - - - - - - - -Removes all cookies from the CookieJar. - - -
- -[removeAllCookiesSync()](./tough-cookie.cookiejar.removeallcookiessync.md) - - - - - - - -Removes all cookies from the CookieJar. - -Note: Only works if the configured Store is also synchronous. - - -
- -[serialize(callback)](./tough-cookie.cookiejar.serialize.md) - - - - - - - -Serialize the CookieJar if the underlying store supports `.getAllCookies`. - - -
- -[serialize()](./tough-cookie.cookiejar.serialize_1.md) - - - - - - - -Serialize the CookieJar if the underlying store supports `.getAllCookies`. - - -
- -[serializeSync()](./tough-cookie.cookiejar.serializesync.md) - - - - - - - -Serialize the CookieJar if the underlying store supports `.getAllCookies`. - -Note: Only works if the configured Store is also synchronous. - - -
- -[setCookie(cookie, url, callback)](./tough-cookie.cookiejar.setcookie.md) - - - - - - - -Attempt to set the [Cookie](./tough-cookie.cookie.md) in the [CookieJar](./tough-cookie.cookiejar.md). - - -
- -[setCookie(cookie, url, options, callback)](./tough-cookie.cookiejar.setcookie_1.md) - - - - - - - -Attempt to set the [Cookie](./tough-cookie.cookie.md) in the [CookieJar](./tough-cookie.cookiejar.md). - - -
- -[setCookie(cookie, url, options)](./tough-cookie.cookiejar.setcookie_2.md) - - - - - - - -Attempt to set the [Cookie](./tough-cookie.cookie.md) in the [CookieJar](./tough-cookie.cookiejar.md). - - -
- -[setCookieSync(cookie, url, options)](./tough-cookie.cookiejar.setcookiesync.md) - - - - - - - -Synchronously attempt to set the [Cookie](./tough-cookie.cookie.md) in the [CookieJar](./tough-cookie.cookiejar.md). - -Note: Only works if the configured [Store](./tough-cookie.store.md) is also synchronous. - - -
- -[toJSON()](./tough-cookie.cookiejar.tojson.md) - - - - - - - -Alias of [CookieJar.serializeSync()](./tough-cookie.cookiejar.serializesync.md). Allows the cookie to be serialized with `JSON.stringify(cookieJar)`. - - -
+ + +[Home](./index.md) > [tough-cookie](./tough-cookie.md) > [CookieJar](./tough-cookie.cookiejar.md) + +## CookieJar class + +A CookieJar is for storage and retrieval of [Cookie](./tough-cookie.cookie.md) objects as defined in [RFC6265 - Section 5.3](https://www.rfc-editor.org/rfc/rfc6265.html#section-5.3). + +It also supports a pluggable persistence layer via [Store](./tough-cookie.store.md). + +**Signature:** + +```typescript +export declare class CookieJar +``` + +## Constructors + + + +
+ +Constructor + + + + +Modifiers + + + + +Description + + +
+ +[(constructor)(store, options)](./tough-cookie.cookiejar._constructor_.md) + + + + + + + +Creates a new `CookieJar` instance. + + +
+ +## Properties + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[prefixSecurity](./tough-cookie.cookiejar.prefixsecurity.md) + + + + +`readonly` + + + + +string + + + + +The configured [PrefixSecurityEnum](./tough-cookie.prefixsecurityenum.md) value for the [CookieJar](./tough-cookie.cookiejar.md). + + +
+ +[store](./tough-cookie.cookiejar.store.md) + + + + +`readonly` + + + + +[Store](./tough-cookie.store.md) + + + + +The configured [Store](./tough-cookie.store.md) for the [CookieJar](./tough-cookie.cookiejar.md). + + +
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +Method + + + + +Modifiers + + + + +Description + + +
+ +[clone(callback)](./tough-cookie.cookiejar.clone.md) + + + + + + + +Produces a deep clone of this CookieJar. Modifications to the original do not affect the clone, and vice versa. + + +
+ +[clone(newStore, callback)](./tough-cookie.cookiejar.clone_1.md) + + + + + + + +Produces a deep clone of this CookieJar. Modifications to the original do not affect the clone, and vice versa. + + +
+ +[clone(newStore)](./tough-cookie.cookiejar.clone_2.md) + + + + + + + +Produces a deep clone of this CookieJar. Modifications to the original do not affect the clone, and vice versa. + + +
+ +[cloneSync(newStore)](./tough-cookie.cookiejar.clonesync.md) + + + + + + + +Produces a deep clone of this CookieJar. Modifications to the original do not affect the clone, and vice versa. + +Note: Only works if both the configured Store and destination Store are synchronous. + + +
+ +[deserialize(strOrObj, callback)](./tough-cookie.cookiejar.deserialize.md) + + + + +`static` + + + + +A new CookieJar is created and the serialized [Cookie](./tough-cookie.cookie.md) values are added to the underlying store. Each [Cookie](./tough-cookie.cookie.md) is added via `store.putCookie(...)` in the order in which they appear in the serialization. + + +
+ +[deserialize(strOrObj, store, callback)](./tough-cookie.cookiejar.deserialize_1.md) + + + + +`static` + + + + +A new CookieJar is created and the serialized [Cookie](./tough-cookie.cookie.md) values are added to the underlying store. Each [Cookie](./tough-cookie.cookie.md) is added via `store.putCookie(...)` in the order in which they appear in the serialization. + + +
+ +[deserialize(strOrObj, store)](./tough-cookie.cookiejar.deserialize_2.md) + + + + +`static` + + + + +A new CookieJar is created and the serialized [Cookie](./tough-cookie.cookie.md) values are added to the underlying store. Each [Cookie](./tough-cookie.cookie.md) is added via `store.putCookie(...)` in the order in which they appear in the serialization. + + +
+ +[deserializeSync(strOrObj, store)](./tough-cookie.cookiejar.deserializesync.md) + + + + +`static` + + + + +A new CookieJar is created and the serialized [Cookie](./tough-cookie.cookie.md) values are added to the underlying store. Each [Cookie](./tough-cookie.cookie.md) is added via `store.putCookie(...)` in the order in which they appear in the serialization. + +Note: Only works if the configured Store is also synchronous. + + +
+ +[fromJSON(jsonString, store)](./tough-cookie.cookiejar.fromjson.md) + + + + +`static` + + + + +Alias of [CookieJar.deserializeSync()](./tough-cookie.cookiejar.deserializesync.md). + + +
+ +[getCookies(url, callback)](./tough-cookie.cookiejar.getcookies.md) + + + + + + + +Retrieve the list of cookies that can be sent in a Cookie header for the current URL. + + +
+ +[getCookies(url, options, callback)](./tough-cookie.cookiejar.getcookies_1.md) + + + + + + + +Retrieve the list of cookies that can be sent in a Cookie header for the current URL. + + +
+ +[getCookies(url, options)](./tough-cookie.cookiejar.getcookies_2.md) + + + + + + + +Retrieve the list of cookies that can be sent in a Cookie header for the current URL. + + +
+ +[getCookiesSync(url, options)](./tough-cookie.cookiejar.getcookiessync.md) + + + + + + + +Synchronously retrieve the list of cookies that can be sent in a Cookie header for the current URL. + +Note: Only works if the configured Store is also synchronous. + + +
+ +[getCookieString(url, options, callback)](./tough-cookie.cookiejar.getcookiestring.md) + + + + + + + +Accepts the same options as `.getCookies()` but returns a string suitable for a `Cookie` header rather than an Array. + + +
+ +[getCookieString(url, callback)](./tough-cookie.cookiejar.getcookiestring_1.md) + + + + + + + +Accepts the same options as `.getCookies()` but returns a string suitable for a `Cookie` header rather than an Array. + + +
+ +[getCookieString(url, options)](./tough-cookie.cookiejar.getcookiestring_2.md) + + + + + + + +Accepts the same options as `.getCookies()` but returns a string suitable for a `Cookie` header rather than an Array. + + +
+ +[getCookieStringSync(url, options)](./tough-cookie.cookiejar.getcookiestringsync.md) + + + + + + + +Synchronous version of `.getCookieString()`. Accepts the same options as `.getCookies()` but returns a string suitable for a `Cookie` header rather than an Array. + +Note: Only works if the configured Store is also synchronous. + + +
+ +[getSetCookieStrings(url, callback)](./tough-cookie.cookiejar.getsetcookiestrings.md) + + + + + + + +Returns an array of strings suitable for `Set-Cookie` headers. Accepts the same options as `.getCookies()`. + + +
+ +[getSetCookieStrings(url, options, callback)](./tough-cookie.cookiejar.getsetcookiestrings_1.md) + + + + + + + +Returns an array of strings suitable for `Set-Cookie` headers. Accepts the same options as `.getCookies()`. + + +
+ +[getSetCookieStrings(url, options)](./tough-cookie.cookiejar.getsetcookiestrings_2.md) + + + + + + + +Returns an array of strings suitable for `Set-Cookie` headers. Accepts the same options as `.getCookies()`. + + +
+ +[getSetCookieStringsSync(url, options)](./tough-cookie.cookiejar.getsetcookiestringssync.md) + + + + + + + +Synchronous version of `.getSetCookieStrings()`. Returns an array of strings suitable for `Set-Cookie` headers. Accepts the same options as `.getCookies()`. + +Note: Only works if the configured Store is also synchronous. + + +
+ +[removeAllCookies(callback)](./tough-cookie.cookiejar.removeallcookies.md) + + + + + + + +Removes all cookies from the CookieJar. + + +
+ +[removeAllCookies()](./tough-cookie.cookiejar.removeallcookies_1.md) + + + + + + + +Removes all cookies from the CookieJar. + + +
+ +[removeAllCookiesSync()](./tough-cookie.cookiejar.removeallcookiessync.md) + + + + + + + +Removes all cookies from the CookieJar. + +Note: Only works if the configured Store is also synchronous. + + +
+ +[serialize(callback)](./tough-cookie.cookiejar.serialize.md) + + + + + + + +Serialize the CookieJar if the underlying store supports `.getAllCookies`. + + +
+ +[serialize()](./tough-cookie.cookiejar.serialize_1.md) + + + + + + + +Serialize the CookieJar if the underlying store supports `.getAllCookies`. + + +
+ +[serializeSync()](./tough-cookie.cookiejar.serializesync.md) + + + + + + + +Serialize the CookieJar if the underlying store supports `.getAllCookies`. + +Note: Only works if the configured Store is also synchronous. + + +
+ +[setCookie(cookie, url, callback)](./tough-cookie.cookiejar.setcookie.md) + + + + + + + +Attempt to set the [Cookie](./tough-cookie.cookie.md) in the [CookieJar](./tough-cookie.cookiejar.md). + + +
+ +[setCookie(cookie, url, options, callback)](./tough-cookie.cookiejar.setcookie_1.md) + + + + + + + +Attempt to set the [Cookie](./tough-cookie.cookie.md) in the [CookieJar](./tough-cookie.cookiejar.md). + + +
+ +[setCookie(cookie, url, options)](./tough-cookie.cookiejar.setcookie_2.md) + + + + + + + +Attempt to set the [Cookie](./tough-cookie.cookie.md) in the [CookieJar](./tough-cookie.cookiejar.md). + + +
+ +[setCookieSync(cookie, url, options)](./tough-cookie.cookiejar.setcookiesync.md) + + + + + + + +Synchronously attempt to set the [Cookie](./tough-cookie.cookie.md) in the [CookieJar](./tough-cookie.cookiejar.md). + +Note: Only works if the configured [Store](./tough-cookie.store.md) is also synchronous. + + +
+ +[toJSON()](./tough-cookie.cookiejar.tojson.md) + + + + + + + +Alias of [CookieJar.serializeSync()](./tough-cookie.cookiejar.serializesync.md). Allows the cookie to be serialized with `JSON.stringify(cookieJar)`. + + +
diff --git a/api/docs/tough-cookie.cookiejar.prefixsecurity.md b/api/docs/tough-cookie.cookiejar.prefixsecurity.md index 0a7cdd6f..6d0ab52d 100644 --- a/api/docs/tough-cookie.cookiejar.prefixsecurity.md +++ b/api/docs/tough-cookie.cookiejar.prefixsecurity.md @@ -1,13 +1,13 @@ - - -[Home](./index.md) > [tough-cookie](./tough-cookie.md) > [CookieJar](./tough-cookie.cookiejar.md) > [prefixSecurity](./tough-cookie.cookiejar.prefixsecurity.md) - -## CookieJar.prefixSecurity property - -The configured [PrefixSecurityEnum](./tough-cookie.prefixsecurityenum.md) value for the [CookieJar](./tough-cookie.cookiejar.md). - -**Signature:** - -```typescript -readonly prefixSecurity: string; -``` + + +[Home](./index.md) > [tough-cookie](./tough-cookie.md) > [CookieJar](./tough-cookie.cookiejar.md) > [prefixSecurity](./tough-cookie.cookiejar.prefixsecurity.md) + +## CookieJar.prefixSecurity property + +The configured [PrefixSecurityEnum](./tough-cookie.prefixsecurityenum.md) value for the [CookieJar](./tough-cookie.cookiejar.md). + +**Signature:** + +```typescript +readonly prefixSecurity: string; +``` diff --git a/api/docs/tough-cookie.cookiejar.removeallcookies.md b/api/docs/tough-cookie.cookiejar.removeallcookies.md index ad480171..028c4d23 100644 --- a/api/docs/tough-cookie.cookiejar.removeallcookies.md +++ b/api/docs/tough-cookie.cookiejar.removeallcookies.md @@ -1,61 +1,61 @@ - - -[Home](./index.md) > [tough-cookie](./tough-cookie.md) > [CookieJar](./tough-cookie.cookiejar.md) > [removeAllCookies](./tough-cookie.cookiejar.removeallcookies.md) - -## CookieJar.removeAllCookies() method - -Removes all cookies from the CookieJar. - -**Signature:** - -```typescript -removeAllCookies(callback: ErrorCallback): void; -``` - -## Parameters - - - -
- -Parameter - - - - -Type - - - - -Description - - -
- -callback - - - - -[ErrorCallback](./tough-cookie.errorcallback.md) - - - - -A function to call when all the cookies have been removed. - - -
-**Returns:** - -void - -## 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. - + + +[Home](./index.md) > [tough-cookie](./tough-cookie.md) > [CookieJar](./tough-cookie.cookiejar.md) > [removeAllCookies](./tough-cookie.cookiejar.removeallcookies.md) + +## CookieJar.removeAllCookies() method + +Removes all cookies from the CookieJar. + +**Signature:** + +```typescript +removeAllCookies(callback: ErrorCallback): void; +``` + +## Parameters + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +callback + + + + +[ErrorCallback](./tough-cookie.errorcallback.md) + + + + +A function to call when all the cookies have been removed. + + +
+**Returns:** + +void + +## 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. + diff --git a/api/docs/tough-cookie.cookiejar.removeallcookies_1.md b/api/docs/tough-cookie.cookiejar.removeallcookies_1.md index f35ed848..72bc852a 100644 --- a/api/docs/tough-cookie.cookiejar.removeallcookies_1.md +++ b/api/docs/tough-cookie.cookiejar.removeallcookies_1.md @@ -1,25 +1,25 @@ - - -[Home](./index.md) > [tough-cookie](./tough-cookie.md) > [CookieJar](./tough-cookie.cookiejar.md) > [removeAllCookies](./tough-cookie.cookiejar.removeallcookies_1.md) - -## CookieJar.removeAllCookies() method - -Removes all cookies from the CookieJar. - -**Signature:** - -```typescript -removeAllCookies(): Promise; -``` -**Returns:** - -Promise<void> - -## 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. - + + +[Home](./index.md) > [tough-cookie](./tough-cookie.md) > [CookieJar](./tough-cookie.cookiejar.md) > [removeAllCookies](./tough-cookie.cookiejar.removeallcookies_1.md) + +## CookieJar.removeAllCookies() method + +Removes all cookies from the CookieJar. + +**Signature:** + +```typescript +removeAllCookies(): Promise; +``` +**Returns:** + +Promise<void> + +## 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. + diff --git a/api/docs/tough-cookie.cookiejar.removeallcookiessync.md b/api/docs/tough-cookie.cookiejar.removeallcookiessync.md index 508673a7..194189c5 100644 --- a/api/docs/tough-cookie.cookiejar.removeallcookiessync.md +++ b/api/docs/tough-cookie.cookiejar.removeallcookiessync.md @@ -1,27 +1,27 @@ - - -[Home](./index.md) > [tough-cookie](./tough-cookie.md) > [CookieJar](./tough-cookie.cookiejar.md) > [removeAllCookiesSync](./tough-cookie.cookiejar.removeallcookiessync.md) - -## CookieJar.removeAllCookiesSync() method - -Removes all cookies from the CookieJar. - -Note: Only works if the configured Store is also synchronous. - -**Signature:** - -```typescript -removeAllCookiesSync(): void; -``` -**Returns:** - -void - -## 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. - + + +[Home](./index.md) > [tough-cookie](./tough-cookie.md) > [CookieJar](./tough-cookie.cookiejar.md) > [removeAllCookiesSync](./tough-cookie.cookiejar.removeallcookiessync.md) + +## CookieJar.removeAllCookiesSync() method + +Removes all cookies from the CookieJar. + +Note: Only works if the configured Store is also synchronous. + +**Signature:** + +```typescript +removeAllCookiesSync(): void; +``` +**Returns:** + +void + +## 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. + diff --git a/api/docs/tough-cookie.cookiejar.serialize.md b/api/docs/tough-cookie.cookiejar.serialize.md index 82decd06..30767c50 100644 --- a/api/docs/tough-cookie.cookiejar.serialize.md +++ b/api/docs/tough-cookie.cookiejar.serialize.md @@ -1,53 +1,53 @@ - - -[Home](./index.md) > [tough-cookie](./tough-cookie.md) > [CookieJar](./tough-cookie.cookiejar.md) > [serialize](./tough-cookie.cookiejar.serialize.md) - -## CookieJar.serialize() method - -Serialize the CookieJar if the underlying store supports `.getAllCookies`. - -**Signature:** - -```typescript -serialize(callback: Callback): void; -``` - -## Parameters - - - -
- -Parameter - - - - -Type - - - - -Description - - -
- -callback - - - - -[Callback](./tough-cookie.callback.md)<[SerializedCookieJar](./tough-cookie.serializedcookiejar.md)> - - - - -A function to call after the CookieJar has been serialized - - -
-**Returns:** - -void - + + +[Home](./index.md) > [tough-cookie](./tough-cookie.md) > [CookieJar](./tough-cookie.cookiejar.md) > [serialize](./tough-cookie.cookiejar.serialize.md) + +## CookieJar.serialize() method + +Serialize the CookieJar if the underlying store supports `.getAllCookies`. + +**Signature:** + +```typescript +serialize(callback: Callback): void; +``` + +## Parameters + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +callback + + + + +[Callback](./tough-cookie.callback.md)<[SerializedCookieJar](./tough-cookie.serializedcookiejar.md)> + + + + +A function to call after the CookieJar has been serialized + + +
+**Returns:** + +void + diff --git a/api/docs/tough-cookie.cookiejar.serialize_1.md b/api/docs/tough-cookie.cookiejar.serialize_1.md index 20a59000..391884c4 100644 --- a/api/docs/tough-cookie.cookiejar.serialize_1.md +++ b/api/docs/tough-cookie.cookiejar.serialize_1.md @@ -1,17 +1,17 @@ - - -[Home](./index.md) > [tough-cookie](./tough-cookie.md) > [CookieJar](./tough-cookie.cookiejar.md) > [serialize](./tough-cookie.cookiejar.serialize_1.md) - -## CookieJar.serialize() method - -Serialize the CookieJar if the underlying store supports `.getAllCookies`. - -**Signature:** - -```typescript -serialize(): Promise; -``` -**Returns:** - -Promise<[SerializedCookieJar](./tough-cookie.serializedcookiejar.md)> - + + +[Home](./index.md) > [tough-cookie](./tough-cookie.md) > [CookieJar](./tough-cookie.cookiejar.md) > [serialize](./tough-cookie.cookiejar.serialize_1.md) + +## CookieJar.serialize() method + +Serialize the CookieJar if the underlying store supports `.getAllCookies`. + +**Signature:** + +```typescript +serialize(): Promise; +``` +**Returns:** + +Promise<[SerializedCookieJar](./tough-cookie.serializedcookiejar.md)> + diff --git a/api/docs/tough-cookie.cookiejar.serializesync.md b/api/docs/tough-cookie.cookiejar.serializesync.md index 1b7c9337..87eb4bd8 100644 --- a/api/docs/tough-cookie.cookiejar.serializesync.md +++ b/api/docs/tough-cookie.cookiejar.serializesync.md @@ -1,19 +1,19 @@ - - -[Home](./index.md) > [tough-cookie](./tough-cookie.md) > [CookieJar](./tough-cookie.cookiejar.md) > [serializeSync](./tough-cookie.cookiejar.serializesync.md) - -## CookieJar.serializeSync() method - -Serialize the CookieJar if the underlying store supports `.getAllCookies`. - -Note: Only works if the configured Store is also synchronous. - -**Signature:** - -```typescript -serializeSync(): SerializedCookieJar | undefined; -``` -**Returns:** - -[SerializedCookieJar](./tough-cookie.serializedcookiejar.md) \| undefined - + + +[Home](./index.md) > [tough-cookie](./tough-cookie.md) > [CookieJar](./tough-cookie.cookiejar.md) > [serializeSync](./tough-cookie.cookiejar.serializesync.md) + +## CookieJar.serializeSync() method + +Serialize the CookieJar if the underlying store supports `.getAllCookies`. + +Note: Only works if the configured Store is also synchronous. + +**Signature:** + +```typescript +serializeSync(): SerializedCookieJar | undefined; +``` +**Returns:** + +[SerializedCookieJar](./tough-cookie.serializedcookiejar.md) \| undefined + diff --git a/api/docs/tough-cookie.cookiejar.setcookie.md b/api/docs/tough-cookie.cookiejar.setcookie.md index b4cd4e6b..b54334f5 100644 --- a/api/docs/tough-cookie.cookiejar.setcookie.md +++ b/api/docs/tough-cookie.cookiejar.setcookie.md @@ -1,91 +1,91 @@ - - -[Home](./index.md) > [tough-cookie](./tough-cookie.md) > [CookieJar](./tough-cookie.cookiejar.md) > [setCookie](./tough-cookie.cookiejar.setcookie.md) - -## CookieJar.setCookie() method - -Attempt to set the [Cookie](./tough-cookie.cookie.md) in the [CookieJar](./tough-cookie.cookiejar.md). - -**Signature:** - -```typescript -setCookie(cookie: string | Cookie, url: string | URL, callback: Callback): void; -``` - -## Parameters - - - - - -
- -Parameter - - - - -Type - - - - -Description - - -
- -cookie - - - - -string \| [Cookie](./tough-cookie.cookie.md) - - - - -The cookie object or cookie string to store. A string value will be parsed into a cookie using [Cookie.parse()](./tough-cookie.cookie.parse.md). - - -
- -url - - - - -string \| URL - - - - -The domain to store the cookie with. - - -
- -callback - - - - -[Callback](./tough-cookie.callback.md)<[Cookie](./tough-cookie.cookie.md) \| undefined> - - - - -A function to call after a cookie has been successfully stored. - - -
-**Returns:** - -void - -## Remarks - -- If successfully persisted, the [Cookie](./tough-cookie.cookie.md) will have updated [Cookie.creation](./tough-cookie.cookie.creation.md), [Cookie.lastAccessed](./tough-cookie.cookie.lastaccessed.md) and [Cookie.hostOnly](./tough-cookie.cookie.hostonly.md) properties. - -- As per the RFC, the [Cookie.hostOnly](./tough-cookie.cookie.hostonly.md) flag is set if there was no `Domain={value}` atttribute on the cookie string. The [Cookie.domain](./tough-cookie.cookie.domain.md) property is set to the fully-qualified hostname of `currentUrl` in this case. Matching this cookie requires an exact hostname match (not a [domainMatch()](./tough-cookie.domainmatch.md) as per usual) - + + +[Home](./index.md) > [tough-cookie](./tough-cookie.md) > [CookieJar](./tough-cookie.cookiejar.md) > [setCookie](./tough-cookie.cookiejar.setcookie.md) + +## CookieJar.setCookie() method + +Attempt to set the [Cookie](./tough-cookie.cookie.md) in the [CookieJar](./tough-cookie.cookiejar.md). + +**Signature:** + +```typescript +setCookie(cookie: string | Cookie, url: string | URL, callback: Callback): void; +``` + +## Parameters + + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +cookie + + + + +string \| [Cookie](./tough-cookie.cookie.md) + + + + +The cookie object or cookie string to store. A string value will be parsed into a cookie using [Cookie.parse()](./tough-cookie.cookie.parse.md). + + +
+ +url + + + + +string \| URL + + + + +The domain to store the cookie with. + + +
+ +callback + + + + +[Callback](./tough-cookie.callback.md)<[Cookie](./tough-cookie.cookie.md) \| undefined> + + + + +A function to call after a cookie has been successfully stored. + + +
+**Returns:** + +void + +## Remarks + +- If successfully persisted, the [Cookie](./tough-cookie.cookie.md) will have updated [Cookie.creation](./tough-cookie.cookie.creation.md), [Cookie.lastAccessed](./tough-cookie.cookie.lastaccessed.md) and [Cookie.hostOnly](./tough-cookie.cookie.hostonly.md) properties. + +- As per the RFC, the [Cookie.hostOnly](./tough-cookie.cookie.hostonly.md) flag is set if there was no `Domain={value}` atttribute on the cookie string. The [Cookie.domain](./tough-cookie.cookie.domain.md) property is set to the fully-qualified hostname of `currentUrl` in this case. Matching this cookie requires an exact hostname match (not a [domainMatch()](./tough-cookie.domainmatch.md) as per usual) + diff --git a/api/docs/tough-cookie.cookiejar.setcookie_1.md b/api/docs/tough-cookie.cookiejar.setcookie_1.md index 92eb8c27..22df45b0 100644 --- a/api/docs/tough-cookie.cookiejar.setcookie_1.md +++ b/api/docs/tough-cookie.cookiejar.setcookie_1.md @@ -1,107 +1,107 @@ - - -[Home](./index.md) > [tough-cookie](./tough-cookie.md) > [CookieJar](./tough-cookie.cookiejar.md) > [setCookie](./tough-cookie.cookiejar.setcookie_1.md) - -## CookieJar.setCookie() method - -Attempt to set the [Cookie](./tough-cookie.cookie.md) in the [CookieJar](./tough-cookie.cookiejar.md). - -**Signature:** - -```typescript -setCookie(cookie: string | Cookie, url: string | URL, options: SetCookieOptions, callback: Callback): void; -``` - -## Parameters - - - - - - -
- -Parameter - - - - -Type - - - - -Description - - -
- -cookie - - - - -string \| [Cookie](./tough-cookie.cookie.md) - - - - -The cookie object or cookie string to store. A string value will be parsed into a cookie using [Cookie.parse()](./tough-cookie.cookie.parse.md). - - -
- -url - - - - -string \| URL - - - - -The domain to store the cookie with. - - -
- -options - - - - -[SetCookieOptions](./tough-cookie.setcookieoptions.md) - - - - -Configuration settings to use when storing the cookie. - - -
- -callback - - - - -[Callback](./tough-cookie.callback.md)<[Cookie](./tough-cookie.cookie.md) \| undefined> - - - - -A function to call after a cookie has been successfully stored. - - -
-**Returns:** - -void - -## Remarks - -- If successfully persisted, the [Cookie](./tough-cookie.cookie.md) will have updated [Cookie.creation](./tough-cookie.cookie.creation.md), [Cookie.lastAccessed](./tough-cookie.cookie.lastaccessed.md) and [Cookie.hostOnly](./tough-cookie.cookie.hostonly.md) properties. - -- As per the RFC, the [Cookie.hostOnly](./tough-cookie.cookie.hostonly.md) flag is set if there was no `Domain={value}` atttribute on the cookie string. The [Cookie.domain](./tough-cookie.cookie.domain.md) property is set to the fully-qualified hostname of `currentUrl` in this case. Matching this cookie requires an exact hostname match (not a [domainMatch()](./tough-cookie.domainmatch.md) as per usual) - + + +[Home](./index.md) > [tough-cookie](./tough-cookie.md) > [CookieJar](./tough-cookie.cookiejar.md) > [setCookie](./tough-cookie.cookiejar.setcookie_1.md) + +## CookieJar.setCookie() method + +Attempt to set the [Cookie](./tough-cookie.cookie.md) in the [CookieJar](./tough-cookie.cookiejar.md). + +**Signature:** + +```typescript +setCookie(cookie: string | Cookie, url: string | URL, options: SetCookieOptions, callback: Callback): void; +``` + +## Parameters + + + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +cookie + + + + +string \| [Cookie](./tough-cookie.cookie.md) + + + + +The cookie object or cookie string to store. A string value will be parsed into a cookie using [Cookie.parse()](./tough-cookie.cookie.parse.md). + + +
+ +url + + + + +string \| URL + + + + +The domain to store the cookie with. + + +
+ +options + + + + +[SetCookieOptions](./tough-cookie.setcookieoptions.md) + + + + +Configuration settings to use when storing the cookie. + + +
+ +callback + + + + +[Callback](./tough-cookie.callback.md)<[Cookie](./tough-cookie.cookie.md) \| undefined> + + + + +A function to call after a cookie has been successfully stored. + + +
+**Returns:** + +void + +## Remarks + +- If successfully persisted, the [Cookie](./tough-cookie.cookie.md) will have updated [Cookie.creation](./tough-cookie.cookie.creation.md), [Cookie.lastAccessed](./tough-cookie.cookie.lastaccessed.md) and [Cookie.hostOnly](./tough-cookie.cookie.hostonly.md) properties. + +- As per the RFC, the [Cookie.hostOnly](./tough-cookie.cookie.hostonly.md) flag is set if there was no `Domain={value}` atttribute on the cookie string. The [Cookie.domain](./tough-cookie.cookie.domain.md) property is set to the fully-qualified hostname of `currentUrl` in this case. Matching this cookie requires an exact hostname match (not a [domainMatch()](./tough-cookie.domainmatch.md) as per usual) + diff --git a/api/docs/tough-cookie.cookiejar.setcookie_2.md b/api/docs/tough-cookie.cookiejar.setcookie_2.md index 5867e372..c2424bc1 100644 --- a/api/docs/tough-cookie.cookiejar.setcookie_2.md +++ b/api/docs/tough-cookie.cookiejar.setcookie_2.md @@ -1,91 +1,91 @@ - - -[Home](./index.md) > [tough-cookie](./tough-cookie.md) > [CookieJar](./tough-cookie.cookiejar.md) > [setCookie](./tough-cookie.cookiejar.setcookie_2.md) - -## CookieJar.setCookie() method - -Attempt to set the [Cookie](./tough-cookie.cookie.md) in the [CookieJar](./tough-cookie.cookiejar.md). - -**Signature:** - -```typescript -setCookie(cookie: string | Cookie, url: string | URL, options?: SetCookieOptions): Promise; -``` - -## Parameters - - - - - -
- -Parameter - - - - -Type - - - - -Description - - -
- -cookie - - - - -string \| [Cookie](./tough-cookie.cookie.md) - - - - -The cookie object or cookie string to store. A string value will be parsed into a cookie using [Cookie.parse()](./tough-cookie.cookie.parse.md). - - -
- -url - - - - -string \| URL - - - - -The domain to store the cookie with. - - -
- -options - - - - -[SetCookieOptions](./tough-cookie.setcookieoptions.md) - - - - -_(Optional)_ Configuration settings to use when storing the cookie. - - -
-**Returns:** - -Promise<[Cookie](./tough-cookie.cookie.md) \| undefined> - -## Remarks - -- If successfully persisted, the [Cookie](./tough-cookie.cookie.md) will have updated [Cookie.creation](./tough-cookie.cookie.creation.md), [Cookie.lastAccessed](./tough-cookie.cookie.lastaccessed.md) and [Cookie.hostOnly](./tough-cookie.cookie.hostonly.md) properties. - -- As per the RFC, the [Cookie.hostOnly](./tough-cookie.cookie.hostonly.md) flag is set if there was no `Domain={value}` atttribute on the cookie string. The [Cookie.domain](./tough-cookie.cookie.domain.md) property is set to the fully-qualified hostname of `currentUrl` in this case. Matching this cookie requires an exact hostname match (not a [domainMatch()](./tough-cookie.domainmatch.md) as per usual) - + + +[Home](./index.md) > [tough-cookie](./tough-cookie.md) > [CookieJar](./tough-cookie.cookiejar.md) > [setCookie](./tough-cookie.cookiejar.setcookie_2.md) + +## CookieJar.setCookie() method + +Attempt to set the [Cookie](./tough-cookie.cookie.md) in the [CookieJar](./tough-cookie.cookiejar.md). + +**Signature:** + +```typescript +setCookie(cookie: string | Cookie, url: string | URL, options?: SetCookieOptions): Promise; +``` + +## Parameters + + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +cookie + + + + +string \| [Cookie](./tough-cookie.cookie.md) + + + + +The cookie object or cookie string to store. A string value will be parsed into a cookie using [Cookie.parse()](./tough-cookie.cookie.parse.md). + + +
+ +url + + + + +string \| URL + + + + +The domain to store the cookie with. + + +
+ +options + + + + +[SetCookieOptions](./tough-cookie.setcookieoptions.md) + + + + +_(Optional)_ Configuration settings to use when storing the cookie. + + +
+**Returns:** + +Promise<[Cookie](./tough-cookie.cookie.md) \| undefined> + +## Remarks + +- If successfully persisted, the [Cookie](./tough-cookie.cookie.md) will have updated [Cookie.creation](./tough-cookie.cookie.creation.md), [Cookie.lastAccessed](./tough-cookie.cookie.lastaccessed.md) and [Cookie.hostOnly](./tough-cookie.cookie.hostonly.md) properties. + +- As per the RFC, the [Cookie.hostOnly](./tough-cookie.cookie.hostonly.md) flag is set if there was no `Domain={value}` atttribute on the cookie string. The [Cookie.domain](./tough-cookie.cookie.domain.md) property is set to the fully-qualified hostname of `currentUrl` in this case. Matching this cookie requires an exact hostname match (not a [domainMatch()](./tough-cookie.domainmatch.md) as per usual) + diff --git a/api/docs/tough-cookie.cookiejar.setcookiesync.md b/api/docs/tough-cookie.cookiejar.setcookiesync.md index d09bae88..1cce537c 100644 --- a/api/docs/tough-cookie.cookiejar.setcookiesync.md +++ b/api/docs/tough-cookie.cookiejar.setcookiesync.md @@ -1,93 +1,93 @@ - - -[Home](./index.md) > [tough-cookie](./tough-cookie.md) > [CookieJar](./tough-cookie.cookiejar.md) > [setCookieSync](./tough-cookie.cookiejar.setcookiesync.md) - -## CookieJar.setCookieSync() method - -Synchronously attempt to set the [Cookie](./tough-cookie.cookie.md) in the [CookieJar](./tough-cookie.cookiejar.md). - -Note: Only works if the configured [Store](./tough-cookie.store.md) is also synchronous. - -**Signature:** - -```typescript -setCookieSync(cookie: string | Cookie, url: string, options?: SetCookieOptions): Cookie | undefined; -``` - -## Parameters - - - - - -
- -Parameter - - - - -Type - - - - -Description - - -
- -cookie - - - - -string \| [Cookie](./tough-cookie.cookie.md) - - - - -The cookie object or cookie string to store. A string value will be parsed into a cookie using [Cookie.parse()](./tough-cookie.cookie.parse.md). - - -
- -url - - - - -string - - - - -The domain to store the cookie with. - - -
- -options - - - - -[SetCookieOptions](./tough-cookie.setcookieoptions.md) - - - - -_(Optional)_ Configuration settings to use when storing the cookie. - - -
-**Returns:** - -[Cookie](./tough-cookie.cookie.md) \| undefined - -## Remarks - -- If successfully persisted, the [Cookie](./tough-cookie.cookie.md) will have updated [Cookie.creation](./tough-cookie.cookie.creation.md), [Cookie.lastAccessed](./tough-cookie.cookie.lastaccessed.md) and [Cookie.hostOnly](./tough-cookie.cookie.hostonly.md) properties. - -- As per the RFC, the [Cookie.hostOnly](./tough-cookie.cookie.hostonly.md) flag is set if there was no `Domain={value}` atttribute on the cookie string. The [Cookie.domain](./tough-cookie.cookie.domain.md) property is set to the fully-qualified hostname of `currentUrl` in this case. Matching this cookie requires an exact hostname match (not a [domainMatch()](./tough-cookie.domainmatch.md) as per usual) - + + +[Home](./index.md) > [tough-cookie](./tough-cookie.md) > [CookieJar](./tough-cookie.cookiejar.md) > [setCookieSync](./tough-cookie.cookiejar.setcookiesync.md) + +## CookieJar.setCookieSync() method + +Synchronously attempt to set the [Cookie](./tough-cookie.cookie.md) in the [CookieJar](./tough-cookie.cookiejar.md). + +Note: Only works if the configured [Store](./tough-cookie.store.md) is also synchronous. + +**Signature:** + +```typescript +setCookieSync(cookie: string | Cookie, url: string, options?: SetCookieOptions): Cookie | undefined; +``` + +## Parameters + + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +cookie + + + + +string \| [Cookie](./tough-cookie.cookie.md) + + + + +The cookie object or cookie string to store. A string value will be parsed into a cookie using [Cookie.parse()](./tough-cookie.cookie.parse.md). + + +
+ +url + + + + +string + + + + +The domain to store the cookie with. + + +
+ +options + + + + +[SetCookieOptions](./tough-cookie.setcookieoptions.md) + + + + +_(Optional)_ Configuration settings to use when storing the cookie. + + +
+**Returns:** + +[Cookie](./tough-cookie.cookie.md) \| undefined + +## Remarks + +- If successfully persisted, the [Cookie](./tough-cookie.cookie.md) will have updated [Cookie.creation](./tough-cookie.cookie.creation.md), [Cookie.lastAccessed](./tough-cookie.cookie.lastaccessed.md) and [Cookie.hostOnly](./tough-cookie.cookie.hostonly.md) properties. + +- As per the RFC, the [Cookie.hostOnly](./tough-cookie.cookie.hostonly.md) flag is set if there was no `Domain={value}` atttribute on the cookie string. The [Cookie.domain](./tough-cookie.cookie.domain.md) property is set to the fully-qualified hostname of `currentUrl` in this case. Matching this cookie requires an exact hostname match (not a [domainMatch()](./tough-cookie.domainmatch.md) as per usual) + diff --git a/api/docs/tough-cookie.cookiejar.store.md b/api/docs/tough-cookie.cookiejar.store.md index 66169357..74a5a727 100644 --- a/api/docs/tough-cookie.cookiejar.store.md +++ b/api/docs/tough-cookie.cookiejar.store.md @@ -1,13 +1,13 @@ - - -[Home](./index.md) > [tough-cookie](./tough-cookie.md) > [CookieJar](./tough-cookie.cookiejar.md) > [store](./tough-cookie.cookiejar.store.md) - -## CookieJar.store property - -The configured [Store](./tough-cookie.store.md) for the [CookieJar](./tough-cookie.cookiejar.md). - -**Signature:** - -```typescript -readonly store: Store; -``` + + +[Home](./index.md) > [tough-cookie](./tough-cookie.md) > [CookieJar](./tough-cookie.cookiejar.md) > [store](./tough-cookie.cookiejar.store.md) + +## CookieJar.store property + +The configured [Store](./tough-cookie.store.md) for the [CookieJar](./tough-cookie.cookiejar.md). + +**Signature:** + +```typescript +readonly store: Store; +``` diff --git a/api/docs/tough-cookie.cookiejar.tojson.md b/api/docs/tough-cookie.cookiejar.tojson.md index eb05306d..4319a7c2 100644 --- a/api/docs/tough-cookie.cookiejar.tojson.md +++ b/api/docs/tough-cookie.cookiejar.tojson.md @@ -1,17 +1,17 @@ - - -[Home](./index.md) > [tough-cookie](./tough-cookie.md) > [CookieJar](./tough-cookie.cookiejar.md) > [toJSON](./tough-cookie.cookiejar.tojson.md) - -## CookieJar.toJSON() method - -Alias of [CookieJar.serializeSync()](./tough-cookie.cookiejar.serializesync.md). Allows the cookie to be serialized with `JSON.stringify(cookieJar)`. - -**Signature:** - -```typescript -toJSON(): SerializedCookieJar | undefined; -``` -**Returns:** - -[SerializedCookieJar](./tough-cookie.serializedcookiejar.md) \| undefined - + + +[Home](./index.md) > [tough-cookie](./tough-cookie.md) > [CookieJar](./tough-cookie.cookiejar.md) > [toJSON](./tough-cookie.cookiejar.tojson.md) + +## CookieJar.toJSON() method + +Alias of [CookieJar.serializeSync()](./tough-cookie.cookiejar.serializesync.md). Allows the cookie to be serialized with `JSON.stringify(cookieJar)`. + +**Signature:** + +```typescript +toJSON(): SerializedCookieJar | undefined; +``` +**Returns:** + +[SerializedCookieJar](./tough-cookie.serializedcookiejar.md) \| undefined + diff --git a/api/docs/tough-cookie.getpublicsuffix.md b/api/docs/tough-cookie.getpublicsuffix.md index 6630e86e..8fc01f05 100644 --- a/api/docs/tough-cookie.getpublicsuffix.md +++ b/api/docs/tough-cookie.getpublicsuffix.md @@ -1,81 +1,81 @@ - - -[Home](./index.md) > [tough-cookie](./tough-cookie.md) > [getPublicSuffix](./tough-cookie.getpublicsuffix.md) - -## getPublicSuffix() function - -Returns the public suffix of this hostname. The public suffix is the shortest domain name upon which a cookie can be set. - -**Signature:** - -```typescript -export declare function getPublicSuffix(domain: string, options?: GetPublicSuffixOptions): string | undefined; -``` - -## Parameters - - - - -
- -Parameter - - - - -Type - - - - -Description - - -
- -domain - - - - -string - - - - -the domain attribute of a cookie - - -
- -options - - - - -[GetPublicSuffixOptions](./tough-cookie.getpublicsuffixoptions.md) - - - - -_(Optional)_ optional configuration for controlling how the public suffix is determined - - -
-**Returns:** - -string \| undefined - -## Remarks - -A "public suffix" is a domain that is controlled by a public registry, such as "com", "co.uk", and "pvt.k12.wy.us". This step is essential for preventing attacker.com from disrupting the integrity of example.com by setting a cookie with a Domain attribute of "com". Unfortunately, the set of public suffixes (also known as "registry controlled domains") changes over time. If feasible, user agents SHOULD use an up-to-date public suffix list, such as the one maintained by the Mozilla project at http://publicsuffix.org/. (See [RFC6265 - Section 5.3](https://www.rfc-editor.org/rfc/rfc6265.html#section-5.3)) - -## Example - - -``` -getPublicSuffix('www.example.com') === 'example.com' -getPublicSuffix('www.subdomain.example.com') === 'example.com' -``` - + + +[Home](./index.md) > [tough-cookie](./tough-cookie.md) > [getPublicSuffix](./tough-cookie.getpublicsuffix.md) + +## getPublicSuffix() function + +Returns the public suffix of this hostname. The public suffix is the shortest domain name upon which a cookie can be set. + +**Signature:** + +```typescript +export declare function getPublicSuffix(domain: string, options?: GetPublicSuffixOptions): string | undefined; +``` + +## Parameters + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +domain + + + + +string + + + + +the domain attribute of a cookie + + +
+ +options + + + + +[GetPublicSuffixOptions](./tough-cookie.getpublicsuffixoptions.md) + + + + +_(Optional)_ optional configuration for controlling how the public suffix is determined + + +
+**Returns:** + +string \| undefined + +## Remarks + +A "public suffix" is a domain that is controlled by a public registry, such as "com", "co.uk", and "pvt.k12.wy.us". This step is essential for preventing attacker.com from disrupting the integrity of example.com by setting a cookie with a Domain attribute of "com". Unfortunately, the set of public suffixes (also known as "registry controlled domains") changes over time. If feasible, user agents SHOULD use an up-to-date public suffix list, such as the one maintained by the Mozilla project at http://publicsuffix.org/. (See [RFC6265 - Section 5.3](https://www.rfc-editor.org/rfc/rfc6265.html#section-5.3)) + +## Example + + +``` +getPublicSuffix('www.example.com') === 'example.com' +getPublicSuffix('www.subdomain.example.com') === 'example.com' +``` + diff --git a/api/docs/tough-cookie.getpublicsuffixoptions.md b/api/docs/tough-cookie.getpublicsuffixoptions.md index f356c42a..bc32849d 100644 --- a/api/docs/tough-cookie.getpublicsuffixoptions.md +++ b/api/docs/tough-cookie.getpublicsuffixoptions.md @@ -1,76 +1,76 @@ - - -[Home](./index.md) > [tough-cookie](./tough-cookie.md) > [GetPublicSuffixOptions](./tough-cookie.getpublicsuffixoptions.md) - -## GetPublicSuffixOptions interface - -Options for configuring how [getPublicSuffix()](./tough-cookie.getpublicsuffix.md) behaves. - -**Signature:** - -```typescript -export interface GetPublicSuffixOptions -``` - -## Properties - - - - -
- -Property - - - - -Modifiers - - - - -Type - - - - -Description - - -
- -[allowSpecialUseDomain?](./tough-cookie.getpublicsuffixoptions.allowspecialusedomain.md) - - - - - - - -boolean \| undefined - - - - -_(Optional)_ If set to `true` then the following [Special Use Domains](https://www.rfc-editor.org/rfc/rfc6761.html) will be treated as if they were valid public suffixes ('local', 'example', 'invalid', 'localhost', 'test'). - - -
- -[ignoreError?](./tough-cookie.getpublicsuffixoptions.ignoreerror.md) - - - - - - - -boolean \| undefined - - - - -_(Optional)_ If set to `true` then any errors that occur while executing [getPublicSuffix()](./tough-cookie.getpublicsuffix.md) will be silently ignored. - - -
+ + +[Home](./index.md) > [tough-cookie](./tough-cookie.md) > [GetPublicSuffixOptions](./tough-cookie.getpublicsuffixoptions.md) + +## GetPublicSuffixOptions interface + +Options for configuring how [getPublicSuffix()](./tough-cookie.getpublicsuffix.md) behaves. + +**Signature:** + +```typescript +export interface GetPublicSuffixOptions +``` + +## Properties + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[allowSpecialUseDomain?](./tough-cookie.getpublicsuffixoptions.allowspecialusedomain.md) + + + + + + + +boolean \| undefined + + + + +_(Optional)_ If set to `true` then the following [Special Use Domains](https://www.rfc-editor.org/rfc/rfc6761.html) will be treated as if they were valid public suffixes ('local', 'example', 'invalid', 'localhost', 'test'). + + +
+ +[ignoreError?](./tough-cookie.getpublicsuffixoptions.ignoreerror.md) + + + + + + + +boolean \| undefined + + + + +_(Optional)_ If set to `true` then any errors that occur while executing [getPublicSuffix()](./tough-cookie.getpublicsuffix.md) will be silently ignored. + + +
diff --git a/lib/__tests__/data/parser.ts b/lib/__tests__/data/parser.ts index 3c93221a..2da620c8 100644 --- a/lib/__tests__/data/parser.ts +++ b/lib/__tests__/data/parser.ts @@ -1,5 +1,4 @@ // This file just contains test data, so we don't care about the number of lines. -/* eslint-disable max-lines */ export default [ { test: '0001', diff --git a/lib/cookie/cookie.ts b/lib/cookie/cookie.ts index 1568e50c..3852ee79 100644 --- a/lib/cookie/cookie.ts +++ b/lib/cookie/cookie.ts @@ -28,10 +28,6 @@ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE * POSSIBILITY OF SUCH DAMAGE. */ - -// This file was too big before we added max-lines, and it's ongoing work to reduce its size. -/* eslint max-lines: [1, 800] */ - import { getPublicSuffix } from '../getPublicSuffix' import * as validators from '../validators' import { inOperator } from '../utils' diff --git a/lib/cookie/cookieJar.ts b/lib/cookie/cookieJar.ts index d34008af..3e47e0ce 100644 --- a/lib/cookie/cookieJar.ts +++ b/lib/cookie/cookieJar.ts @@ -26,9 +26,6 @@ import { domainMatch } from './domainMatch' import { cookieCompare } from './cookieCompare' import { version } from '../version' -// This file was too big before we added max-lines, and it's ongoing work to reduce its size. -/* eslint max-lines: [1, 1200] */ - const defaultSetCookieOptions: SetCookieOptions = { loose: false, sameSiteContext: undefined, diff --git a/package-lock.json b/package-lock.json index 4ff85822..516aed97 100644 --- a/package-lock.json +++ b/package-lock.json @@ -14,9 +14,10 @@ "url-parse": "^1.5.10" }, "devDependencies": { + "@microsoft/api-documenter": "^7.23.37", + "@microsoft/api-extractor": "^7.42.3", "@types/jest": "^29.5.10", "@types/node": "^14.18.63", - "@types/psl": "^1.1.3", "@types/punycode": "^2.1.4", "@types/url-parse": "^1.4.11", "@typescript-eslint/eslint-plugin": "^7.1.0", @@ -1513,6 +1514,128 @@ "@jridgewell/sourcemap-codec": "^1.4.14" } }, + "node_modules/@microsoft/api-documenter": { + "version": "7.24.2", + "resolved": "https://registry.npmjs.org/@microsoft/api-documenter/-/api-documenter-7.24.2.tgz", + "integrity": "sha512-q03DXLBj7nzAzLyLRAVklBynqKgSFI/JBmrhF/mEEIpg8orNo4qKXWO1RSkD2IYrqvZV63b13mcUPYgcFdifQA==", + "dev": true, + "dependencies": { + "@microsoft/api-extractor-model": "7.28.14", + "@microsoft/tsdoc": "0.14.2", + "@rushstack/node-core-library": "4.1.0", + "@rushstack/terminal": "0.10.1", + "@rushstack/ts-command-line": "4.19.2", + "js-yaml": "~3.13.1", + "resolve": "~1.22.1" + }, + "bin": { + "api-documenter": "bin/api-documenter" + } + }, + "node_modules/@microsoft/api-documenter/node_modules/js-yaml": { + "version": "3.13.1", + "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-3.13.1.tgz", + "integrity": "sha512-YfbcO7jXDdyj0DGxYVSlSeQNHbD7XPWvrVWeVUujrQEoZzWJIRrCPoyk6kL6IAjAG2IolMK4T0hNUe0HOUs5Jw==", + "dev": true, + "dependencies": { + "argparse": "^1.0.7", + "esprima": "^4.0.0" + }, + "bin": { + "js-yaml": "bin/js-yaml.js" + } + }, + "node_modules/@microsoft/api-extractor": { + "version": "7.43.1", + "resolved": "https://registry.npmjs.org/@microsoft/api-extractor/-/api-extractor-7.43.1.tgz", + "integrity": "sha512-ohg40SsvFFgzHFAtYq5wKJc8ZDyY46bphjtnSvhSSlXpPTG7GHwyyXkn48UZiUCBwr2WC7TRC1Jfwz7nreuiyQ==", + "dev": true, + "dependencies": { + "@microsoft/api-extractor-model": "7.28.14", + "@microsoft/tsdoc": "0.14.2", + "@microsoft/tsdoc-config": "~0.16.1", + "@rushstack/node-core-library": "4.1.0", + "@rushstack/rig-package": "0.5.2", + "@rushstack/terminal": "0.10.1", + "@rushstack/ts-command-line": "4.19.2", + "lodash": "~4.17.15", + "minimatch": "~3.0.3", + "resolve": "~1.22.1", + "semver": "~7.5.4", + "source-map": "~0.6.1", + "typescript": "5.4.2" + }, + "bin": { + "api-extractor": "bin/api-extractor" + } + }, + "node_modules/@microsoft/api-extractor-model": { + "version": "7.28.14", + "resolved": "https://registry.npmjs.org/@microsoft/api-extractor-model/-/api-extractor-model-7.28.14.tgz", + "integrity": "sha512-Bery/c8A8SsKPSvA82cTTuy/+OcxZbLRmKhPkk91/AJOQzxZsShcrmHFAGeiEqSIrv1nPZ3tKq9kfMLdCHmsqg==", + "dev": true, + "dependencies": { + "@microsoft/tsdoc": "0.14.2", + "@microsoft/tsdoc-config": "~0.16.1", + "@rushstack/node-core-library": "4.1.0" + } + }, + "node_modules/@microsoft/api-extractor/node_modules/minimatch": { + "version": "3.0.8", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.0.8.tgz", + "integrity": "sha512-6FsRAQsxQ61mw+qP1ZzbL9Bc78x2p5OqNgNpnoAFLTrX8n5Kxph0CsnhmKKNXTWjXqU5L0pGPR7hYk+XWZr60Q==", + "dev": true, + "dependencies": { + "brace-expansion": "^1.1.7" + }, + "engines": { + "node": "*" + } + }, + "node_modules/@microsoft/api-extractor/node_modules/typescript": { + "version": "5.4.2", + "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.4.2.tgz", + "integrity": "sha512-+2/g0Fds1ERlP6JsakQQDXjZdZMM+rqpamFZJEKh4kwTIn3iDkgKtby0CeNd5ATNZ4Ry1ax15TMx0W2V+miizQ==", + "dev": true, + "bin": { + "tsc": "bin/tsc", + "tsserver": "bin/tsserver" + }, + "engines": { + "node": ">=14.17" + } + }, + "node_modules/@microsoft/tsdoc": { + "version": "0.14.2", + "resolved": "https://registry.npmjs.org/@microsoft/tsdoc/-/tsdoc-0.14.2.tgz", + "integrity": "sha512-9b8mPpKrfeGRuhFH5iO1iwCLeIIsV6+H1sRfxbkoGXIyQE2BTsPd9zqSqQJ+pv5sJ/hT5M1zvOFL02MnEezFug==", + "dev": true + }, + "node_modules/@microsoft/tsdoc-config": { + "version": "0.16.2", + "resolved": "https://registry.npmjs.org/@microsoft/tsdoc-config/-/tsdoc-config-0.16.2.tgz", + "integrity": "sha512-OGiIzzoBLgWWR0UdRJX98oYO+XKGf7tiK4Zk6tQ/E4IJqGCe7dvkTvgDZV5cFJUzLGDOjeAXrnZoA6QkVySuxw==", + "dev": true, + "dependencies": { + "@microsoft/tsdoc": "0.14.2", + "ajv": "~6.12.6", + "jju": "~1.4.0", + "resolve": "~1.19.0" + } + }, + "node_modules/@microsoft/tsdoc-config/node_modules/resolve": { + "version": "1.19.0", + "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.19.0.tgz", + "integrity": "sha512-rArEXAgsBG4UgRGcynxWIWKFvh/XZCcS8UJdHhwy91zwAvCZIbcs+vAbflgBnNjYMs/i/i+/Ux6IZhML1yPvxg==", + "dev": true, + "dependencies": { + "is-core-module": "^2.1.0", + "path-parse": "^1.0.6" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, "node_modules/@nodelib/fs.scandir": { "version": "2.1.5", "resolved": "https://registry.npmjs.org/@nodelib/fs.scandir/-/fs.scandir-2.1.5.tgz", @@ -1560,6 +1683,92 @@ "url": "https://opencollective.com/unts" } }, + "node_modules/@rushstack/node-core-library": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/@rushstack/node-core-library/-/node-core-library-4.1.0.tgz", + "integrity": "sha512-qz4JFBZJCf1YN5cAXa1dP6Mki/HrsQxc/oYGAGx29dF2cwF2YMxHoly0FBhMw3IEnxo5fMj0boVfoHVBkpkx/w==", + "dev": true, + "dependencies": { + "fs-extra": "~7.0.1", + "import-lazy": "~4.0.0", + "jju": "~1.4.0", + "resolve": "~1.22.1", + "semver": "~7.5.4", + "z-schema": "~5.0.2" + }, + "peerDependencies": { + "@types/node": "*" + }, + "peerDependenciesMeta": { + "@types/node": { + "optional": true + } + } + }, + "node_modules/@rushstack/rig-package": { + "version": "0.5.2", + "resolved": "https://registry.npmjs.org/@rushstack/rig-package/-/rig-package-0.5.2.tgz", + "integrity": "sha512-mUDecIJeH3yYGZs2a48k+pbhM6JYwWlgjs2Ca5f2n1G2/kgdgP9D/07oglEGf6mRyXEnazhEENeYTSNDRCwdqA==", + "dev": true, + "dependencies": { + "resolve": "~1.22.1", + "strip-json-comments": "~3.1.1" + } + }, + "node_modules/@rushstack/terminal": { + "version": "0.10.1", + "resolved": "https://registry.npmjs.org/@rushstack/terminal/-/terminal-0.10.1.tgz", + "integrity": "sha512-C6Vi/m/84IYJTkfzmXr1+W8Wi3MmBjVF/q3za91Gb3VYjKbpALHVxY6FgH625AnDe5Z0Kh4MHKWA3Z7bqgAezA==", + "dev": true, + "dependencies": { + "@rushstack/node-core-library": "4.1.0", + "supports-color": "~8.1.1" + }, + "peerDependencies": { + "@types/node": "*" + }, + "peerDependenciesMeta": { + "@types/node": { + "optional": true + } + } + }, + "node_modules/@rushstack/terminal/node_modules/has-flag": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz", + "integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==", + "dev": true, + "engines": { + "node": ">=8" + } + }, + "node_modules/@rushstack/terminal/node_modules/supports-color": { + "version": "8.1.1", + "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-8.1.1.tgz", + "integrity": "sha512-MpUEN2OodtUzxvKQl72cUF7RQ5EiHsGvSsVG0ia9c5RbWGL2CI4C7EpPS8UTBIplnlzZiNuV56w+FuNxy3ty2Q==", + "dev": true, + "dependencies": { + "has-flag": "^4.0.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/chalk/supports-color?sponsor=1" + } + }, + "node_modules/@rushstack/ts-command-line": { + "version": "4.19.2", + "resolved": "https://registry.npmjs.org/@rushstack/ts-command-line/-/ts-command-line-4.19.2.tgz", + "integrity": "sha512-cqmXXmBEBlzo9WtyUrHtF9e6kl0LvBY7aTSVX4jfnBfXWZQWnPq9JTFPlQZ+L/ZwjZ4HrNwQsOVvhe9oOucZkw==", + "dev": true, + "dependencies": { + "@rushstack/terminal": "0.10.1", + "@types/argparse": "1.0.38", + "argparse": "~1.0.9", + "string-argv": "~0.3.1" + } + }, "node_modules/@sinclair/typebox": { "version": "0.27.8", "resolved": "https://registry.npmjs.org/@sinclair/typebox/-/typebox-0.27.8.tgz", @@ -1608,6 +1817,12 @@ "integrity": "sha512-yOlFc+7UtL/89t2ZhjPvvB/DeAr3r+Dq58IgzsFkOAvVC6NMJXmCGjbptdXdR9qsX7pKcTL+s87FtYREi2dEEQ==", "dev": true }, + "node_modules/@types/argparse": { + "version": "1.0.38", + "resolved": "https://registry.npmjs.org/@types/argparse/-/argparse-1.0.38.tgz", + "integrity": "sha512-ebDJ9b0e702Yr7pWgB0jzm+CX4Srzz8RcXtLJDJB+BSccqMa36uyH/zUsSYao5+BD1ytv3k3rPYCq4mAE1hsXA==", + "dev": true + }, "node_modules/@types/babel__core": { "version": "7.20.3", "resolved": "https://registry.npmjs.org/@types/babel__core/-/babel__core-7.20.3.tgz", @@ -1704,12 +1919,6 @@ "integrity": "sha512-fAtCfv4jJg+ExtXhvCkCqUKZ+4ok/JQk01qDKhL5BDDoS3AxKXhV5/MAVUZyQnSEd2GT92fkgZl0pz0Q0AzcIQ==", "dev": true }, - "node_modules/@types/psl": { - "version": "1.1.3", - "resolved": "https://registry.npmjs.org/@types/psl/-/psl-1.1.3.tgz", - "integrity": "sha512-Iu174JHfLd7i/XkXY6VDrqSlPvTDQOtQI7wNAXKKOAADJ9TduRLkNdMgjGiMxSttUIZnomv81JAbAbC0DhggxA==", - "dev": true - }, "node_modules/@types/punycode": { "version": "2.1.4", "resolved": "https://registry.npmjs.org/@types/punycode/-/punycode-2.1.4.tgz", @@ -3356,6 +3565,20 @@ "integrity": "sha512-5nqDSxl8nn5BSNxyR3n4I6eDmbolI6WT+QqR547RwxQapgjQBmtktdP+HTBb/a/zLsbzERTONyUB5pefh5TtjQ==", "dev": true }, + "node_modules/fs-extra": { + "version": "7.0.1", + "resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-7.0.1.tgz", + "integrity": "sha512-YJDaCJZEnBmcbw13fvdAM9AwNOJwOzrE4pqMqBq5nFiEqXUqHwlK4B+3pUw6JNvfSPtX05xFHtYy/1ni01eGCw==", + "dev": true, + "dependencies": { + "graceful-fs": "^4.1.2", + "jsonfile": "^4.0.0", + "universalify": "^0.1.0" + }, + "engines": { + "node": ">=6 <7 || >=8" + } + }, "node_modules/fs.realpath": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/fs.realpath/-/fs.realpath-1.0.0.tgz", @@ -3575,6 +3798,15 @@ "url": "https://github.com/sponsors/sindresorhus" } }, + "node_modules/import-lazy": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/import-lazy/-/import-lazy-4.0.0.tgz", + "integrity": "sha512-rKtvo6a868b5Hu3heneU+L4yEQ4jYKLtjpnPeUdK7h0yzXGmyBTypknlkCvHFBqfX9YlorEiMM6Dnq/5atfHkw==", + "dev": true, + "engines": { + "node": ">=8" + } + }, "node_modules/import-local": { "version": "3.1.0", "resolved": "https://registry.npmjs.org/import-local/-/import-local-3.1.0.tgz", @@ -5485,6 +5717,12 @@ "url": "https://github.com/chalk/supports-color?sponsor=1" } }, + "node_modules/jju": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/jju/-/jju-1.4.0.tgz", + "integrity": "sha512-8wb9Yw966OSxApiCt0K3yNJL8pnNeIv+OEq2YMidz4FKP6nonSRoOXc80iXY4JaN2FC11B9qsNmDsm+ZOfMROA==", + "dev": true + }, "node_modules/js-tokens": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/js-tokens/-/js-tokens-4.0.0.tgz", @@ -5546,6 +5784,15 @@ "node": ">=6" } }, + "node_modules/jsonfile": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/jsonfile/-/jsonfile-4.0.0.tgz", + "integrity": "sha512-m6F1R3z8jjlf2imQHS2Qez5sjKWQzbuuhuJ/FKYFRZvPE3PuHcSMVZzfsLhGVOkfd20obL5SWEBew5ShlquNxg==", + "dev": true, + "optionalDependencies": { + "graceful-fs": "^4.1.6" + } + }, "node_modules/kleur": { "version": "3.0.3", "resolved": "https://registry.npmjs.org/kleur/-/kleur-3.0.3.tgz", @@ -5598,6 +5845,24 @@ "url": "https://github.com/sponsors/sindresorhus" } }, + "node_modules/lodash": { + "version": "4.17.21", + "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.21.tgz", + "integrity": "sha512-v2kDEe57lecTulaDIuNTPy3Ry4gLGJ6Z1O3vE1krgXZNrsQ+LFTGHVxVjcXPs17LhbZVGedAJv8XZ1tvj5FvSg==", + "dev": true + }, + "node_modules/lodash.get": { + "version": "4.4.2", + "resolved": "https://registry.npmjs.org/lodash.get/-/lodash.get-4.4.2.tgz", + "integrity": "sha512-z+Uw/vLuy6gQe8cfaFWD7p0wVv8fJl3mbzXh33RS+0oW2wvUqiRXiQ69gLWSLpgB5/6sU+r6BlQR0MBILadqTQ==", + "dev": true + }, + "node_modules/lodash.isequal": { + "version": "4.5.0", + "resolved": "https://registry.npmjs.org/lodash.isequal/-/lodash.isequal-4.5.0.tgz", + "integrity": "sha512-pDo3lu8Jhfjqls6GkMgpahsF9kCyayhgykjyLMNFTKWrpVdAQtYyB4muAMWozBB4ig/dtWAmsMxLEI8wuz+DYQ==", + "dev": true + }, "node_modules/lodash.memoize": { "version": "4.1.2", "resolved": "https://registry.npmjs.org/lodash.memoize/-/lodash.memoize-4.1.2.tgz", @@ -6349,6 +6614,15 @@ "node": ">=8" } }, + "node_modules/string-argv": { + "version": "0.3.2", + "resolved": "https://registry.npmjs.org/string-argv/-/string-argv-0.3.2.tgz", + "integrity": "sha512-aqD2Q0144Z+/RqG52NeHEkZauTAUWJO8c6yTftGJKO3Tja5tUgIfmIl6kExvhtxSDP7fXB6DvzkfMpCd/F3G+Q==", + "dev": true, + "engines": { + "node": ">=0.6.19" + } + }, "node_modules/string-length": { "version": "4.0.2", "resolved": "https://registry.npmjs.org/string-length/-/string-length-4.0.2.tgz", @@ -6671,6 +6945,15 @@ "node": ">=4.2.0" } }, + "node_modules/universalify": { + "version": "0.1.2", + "resolved": "https://registry.npmjs.org/universalify/-/universalify-0.1.2.tgz", + "integrity": "sha512-rBJeI5CXAlmy1pV+617WB9J63U6XcazHHF2f2dbJix4XzpUF0RS3Zbj0FGIOCAva5P/d/GBOYaACQ1w+0azUkg==", + "dev": true, + "engines": { + "node": ">= 4.0.0" + } + }, "node_modules/update-browserslist-db": { "version": "1.0.10", "resolved": "https://registry.npmjs.org/update-browserslist-db/-/update-browserslist-db-1.0.10.tgz", @@ -6741,6 +7024,15 @@ "integrity": "sha512-Kvp459HrV2FEJ1CAsi1Ku+MY3kasH19TFykTz2xWmMeq6bk2NU3XXvfJ+Q61m0xktWwt+1HSYf3JZsTms3aRJg==", "dev": true }, + "node_modules/validator": { + "version": "13.11.0", + "resolved": "https://registry.npmjs.org/validator/-/validator-13.11.0.tgz", + "integrity": "sha512-Ii+sehpSfZy+At5nPdnyMhx78fEoPDkR2XW/zimHEL3MyGJQOCQ7WeP20jPYRz7ZCpcKLB21NxuXHF3bxjStBQ==", + "dev": true, + "engines": { + "node": ">= 0.10" + } + }, "node_modules/vows": { "version": "0.8.3", "resolved": "https://registry.npmjs.org/vows/-/vows-0.8.3.tgz", @@ -6895,6 +7187,36 @@ "funding": { "url": "https://github.com/sponsors/sindresorhus" } + }, + "node_modules/z-schema": { + "version": "5.0.5", + "resolved": "https://registry.npmjs.org/z-schema/-/z-schema-5.0.5.tgz", + "integrity": "sha512-D7eujBWkLa3p2sIpJA0d1pr7es+a7m0vFAnZLlCEKq/Ij2k0MLi9Br2UPxoxdYystm5K1yeBGzub0FlYUEWj2Q==", + "dev": true, + "dependencies": { + "lodash.get": "^4.4.2", + "lodash.isequal": "^4.5.0", + "validator": "^13.7.0" + }, + "bin": { + "z-schema": "bin/z-schema" + }, + "engines": { + "node": ">=8.0.0" + }, + "optionalDependencies": { + "commander": "^9.4.1" + } + }, + "node_modules/z-schema/node_modules/commander": { + "version": "9.5.0", + "resolved": "https://registry.npmjs.org/commander/-/commander-9.5.0.tgz", + "integrity": "sha512-KRs7WVDKg86PWiuAqhDrAQnTXZKraVcCc6vFdL14qrZ/DcWwuRo7VoiYXalXO7S5GKpqYiVEwCbgFDfxNHKJBQ==", + "dev": true, + "optional": true, + "engines": { + "node": "^12.20.0 || >=14" + } } }, "dependencies": { @@ -8015,6 +8337,112 @@ "@jridgewell/sourcemap-codec": "^1.4.14" } }, + "@microsoft/api-documenter": { + "version": "7.24.2", + "resolved": "https://registry.npmjs.org/@microsoft/api-documenter/-/api-documenter-7.24.2.tgz", + "integrity": "sha512-q03DXLBj7nzAzLyLRAVklBynqKgSFI/JBmrhF/mEEIpg8orNo4qKXWO1RSkD2IYrqvZV63b13mcUPYgcFdifQA==", + "dev": true, + "requires": { + "@microsoft/api-extractor-model": "7.28.14", + "@microsoft/tsdoc": "0.14.2", + "@rushstack/node-core-library": "4.1.0", + "@rushstack/terminal": "0.10.1", + "@rushstack/ts-command-line": "4.19.2", + "js-yaml": "~3.13.1", + "resolve": "~1.22.1" + }, + "dependencies": { + "js-yaml": { + "version": "3.13.1", + "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-3.13.1.tgz", + "integrity": "sha512-YfbcO7jXDdyj0DGxYVSlSeQNHbD7XPWvrVWeVUujrQEoZzWJIRrCPoyk6kL6IAjAG2IolMK4T0hNUe0HOUs5Jw==", + "dev": true, + "requires": { + "argparse": "^1.0.7", + "esprima": "^4.0.0" + } + } + } + }, + "@microsoft/api-extractor": { + "version": "7.43.1", + "resolved": "https://registry.npmjs.org/@microsoft/api-extractor/-/api-extractor-7.43.1.tgz", + "integrity": "sha512-ohg40SsvFFgzHFAtYq5wKJc8ZDyY46bphjtnSvhSSlXpPTG7GHwyyXkn48UZiUCBwr2WC7TRC1Jfwz7nreuiyQ==", + "dev": true, + "requires": { + "@microsoft/api-extractor-model": "7.28.14", + "@microsoft/tsdoc": "0.14.2", + "@microsoft/tsdoc-config": "~0.16.1", + "@rushstack/node-core-library": "4.1.0", + "@rushstack/rig-package": "0.5.2", + "@rushstack/terminal": "0.10.1", + "@rushstack/ts-command-line": "4.19.2", + "lodash": "~4.17.15", + "minimatch": "~3.0.3", + "resolve": "~1.22.1", + "semver": "~7.5.4", + "source-map": "~0.6.1", + "typescript": "5.4.2" + }, + "dependencies": { + "minimatch": { + "version": "3.0.8", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.0.8.tgz", + "integrity": "sha512-6FsRAQsxQ61mw+qP1ZzbL9Bc78x2p5OqNgNpnoAFLTrX8n5Kxph0CsnhmKKNXTWjXqU5L0pGPR7hYk+XWZr60Q==", + "dev": true, + "requires": { + "brace-expansion": "^1.1.7" + } + }, + "typescript": { + "version": "5.4.2", + "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.4.2.tgz", + "integrity": "sha512-+2/g0Fds1ERlP6JsakQQDXjZdZMM+rqpamFZJEKh4kwTIn3iDkgKtby0CeNd5ATNZ4Ry1ax15TMx0W2V+miizQ==", + "dev": true + } + } + }, + "@microsoft/api-extractor-model": { + "version": "7.28.14", + "resolved": "https://registry.npmjs.org/@microsoft/api-extractor-model/-/api-extractor-model-7.28.14.tgz", + "integrity": "sha512-Bery/c8A8SsKPSvA82cTTuy/+OcxZbLRmKhPkk91/AJOQzxZsShcrmHFAGeiEqSIrv1nPZ3tKq9kfMLdCHmsqg==", + "dev": true, + "requires": { + "@microsoft/tsdoc": "0.14.2", + "@microsoft/tsdoc-config": "~0.16.1", + "@rushstack/node-core-library": "4.1.0" + } + }, + "@microsoft/tsdoc": { + "version": "0.14.2", + "resolved": "https://registry.npmjs.org/@microsoft/tsdoc/-/tsdoc-0.14.2.tgz", + "integrity": "sha512-9b8mPpKrfeGRuhFH5iO1iwCLeIIsV6+H1sRfxbkoGXIyQE2BTsPd9zqSqQJ+pv5sJ/hT5M1zvOFL02MnEezFug==", + "dev": true + }, + "@microsoft/tsdoc-config": { + "version": "0.16.2", + "resolved": "https://registry.npmjs.org/@microsoft/tsdoc-config/-/tsdoc-config-0.16.2.tgz", + "integrity": "sha512-OGiIzzoBLgWWR0UdRJX98oYO+XKGf7tiK4Zk6tQ/E4IJqGCe7dvkTvgDZV5cFJUzLGDOjeAXrnZoA6QkVySuxw==", + "dev": true, + "requires": { + "@microsoft/tsdoc": "0.14.2", + "ajv": "~6.12.6", + "jju": "~1.4.0", + "resolve": "~1.19.0" + }, + "dependencies": { + "resolve": { + "version": "1.19.0", + "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.19.0.tgz", + "integrity": "sha512-rArEXAgsBG4UgRGcynxWIWKFvh/XZCcS8UJdHhwy91zwAvCZIbcs+vAbflgBnNjYMs/i/i+/Ux6IZhML1yPvxg==", + "dev": true, + "requires": { + "is-core-module": "^2.1.0", + "path-parse": "^1.0.6" + } + } + } + }, "@nodelib/fs.scandir": { "version": "2.1.5", "resolved": "https://registry.npmjs.org/@nodelib/fs.scandir/-/fs.scandir-2.1.5.tgz", @@ -8047,6 +8475,69 @@ "integrity": "sha512-Zwq5OCzuwJC2jwqmpEQt7Ds1DTi6BWSwoGkbb1n9pO3hzb35BoJELx7c0T23iDkBGkh2e7tvOtjF3tr3OaQHDQ==", "dev": true }, + "@rushstack/node-core-library": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/@rushstack/node-core-library/-/node-core-library-4.1.0.tgz", + "integrity": "sha512-qz4JFBZJCf1YN5cAXa1dP6Mki/HrsQxc/oYGAGx29dF2cwF2YMxHoly0FBhMw3IEnxo5fMj0boVfoHVBkpkx/w==", + "dev": true, + "requires": { + "fs-extra": "~7.0.1", + "import-lazy": "~4.0.0", + "jju": "~1.4.0", + "resolve": "~1.22.1", + "semver": "~7.5.4", + "z-schema": "~5.0.2" + } + }, + "@rushstack/rig-package": { + "version": "0.5.2", + "resolved": "https://registry.npmjs.org/@rushstack/rig-package/-/rig-package-0.5.2.tgz", + "integrity": "sha512-mUDecIJeH3yYGZs2a48k+pbhM6JYwWlgjs2Ca5f2n1G2/kgdgP9D/07oglEGf6mRyXEnazhEENeYTSNDRCwdqA==", + "dev": true, + "requires": { + "resolve": "~1.22.1", + "strip-json-comments": "~3.1.1" + } + }, + "@rushstack/terminal": { + "version": "0.10.1", + "resolved": "https://registry.npmjs.org/@rushstack/terminal/-/terminal-0.10.1.tgz", + "integrity": "sha512-C6Vi/m/84IYJTkfzmXr1+W8Wi3MmBjVF/q3za91Gb3VYjKbpALHVxY6FgH625AnDe5Z0Kh4MHKWA3Z7bqgAezA==", + "dev": true, + "requires": { + "@rushstack/node-core-library": "4.1.0", + "supports-color": "~8.1.1" + }, + "dependencies": { + "has-flag": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz", + "integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==", + "dev": true + }, + "supports-color": { + "version": "8.1.1", + "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-8.1.1.tgz", + "integrity": "sha512-MpUEN2OodtUzxvKQl72cUF7RQ5EiHsGvSsVG0ia9c5RbWGL2CI4C7EpPS8UTBIplnlzZiNuV56w+FuNxy3ty2Q==", + "dev": true, + "requires": { + "has-flag": "^4.0.0" + } + } + } + }, + "@rushstack/ts-command-line": { + "version": "4.19.2", + "resolved": "https://registry.npmjs.org/@rushstack/ts-command-line/-/ts-command-line-4.19.2.tgz", + "integrity": "sha512-cqmXXmBEBlzo9WtyUrHtF9e6kl0LvBY7aTSVX4jfnBfXWZQWnPq9JTFPlQZ+L/ZwjZ4HrNwQsOVvhe9oOucZkw==", + "dev": true, + "requires": { + "@rushstack/terminal": "0.10.1", + "@types/argparse": "1.0.38", + "argparse": "~1.0.9", + "string-argv": "~0.3.1" + } + }, "@sinclair/typebox": { "version": "0.27.8", "resolved": "https://registry.npmjs.org/@sinclair/typebox/-/typebox-0.27.8.tgz", @@ -8095,6 +8586,12 @@ "integrity": "sha512-yOlFc+7UtL/89t2ZhjPvvB/DeAr3r+Dq58IgzsFkOAvVC6NMJXmCGjbptdXdR9qsX7pKcTL+s87FtYREi2dEEQ==", "dev": true }, + "@types/argparse": { + "version": "1.0.38", + "resolved": "https://registry.npmjs.org/@types/argparse/-/argparse-1.0.38.tgz", + "integrity": "sha512-ebDJ9b0e702Yr7pWgB0jzm+CX4Srzz8RcXtLJDJB+BSccqMa36uyH/zUsSYao5+BD1ytv3k3rPYCq4mAE1hsXA==", + "dev": true + }, "@types/babel__core": { "version": "7.20.3", "resolved": "https://registry.npmjs.org/@types/babel__core/-/babel__core-7.20.3.tgz", @@ -8191,12 +8688,6 @@ "integrity": "sha512-fAtCfv4jJg+ExtXhvCkCqUKZ+4ok/JQk01qDKhL5BDDoS3AxKXhV5/MAVUZyQnSEd2GT92fkgZl0pz0Q0AzcIQ==", "dev": true }, - "@types/psl": { - "version": "1.1.3", - "resolved": "https://registry.npmjs.org/@types/psl/-/psl-1.1.3.tgz", - "integrity": "sha512-Iu174JHfLd7i/XkXY6VDrqSlPvTDQOtQI7wNAXKKOAADJ9TduRLkNdMgjGiMxSttUIZnomv81JAbAbC0DhggxA==", - "dev": true - }, "@types/punycode": { "version": "2.1.4", "resolved": "https://registry.npmjs.org/@types/punycode/-/punycode-2.1.4.tgz", @@ -9379,6 +9870,17 @@ "integrity": "sha512-5nqDSxl8nn5BSNxyR3n4I6eDmbolI6WT+QqR547RwxQapgjQBmtktdP+HTBb/a/zLsbzERTONyUB5pefh5TtjQ==", "dev": true }, + "fs-extra": { + "version": "7.0.1", + "resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-7.0.1.tgz", + "integrity": "sha512-YJDaCJZEnBmcbw13fvdAM9AwNOJwOzrE4pqMqBq5nFiEqXUqHwlK4B+3pUw6JNvfSPtX05xFHtYy/1ni01eGCw==", + "dev": true, + "requires": { + "graceful-fs": "^4.1.2", + "jsonfile": "^4.0.0", + "universalify": "^0.1.0" + } + }, "fs.realpath": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/fs.realpath/-/fs.realpath-1.0.0.tgz", @@ -9531,6 +10033,12 @@ "resolve-from": "^4.0.0" } }, + "import-lazy": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/import-lazy/-/import-lazy-4.0.0.tgz", + "integrity": "sha512-rKtvo6a868b5Hu3heneU+L4yEQ4jYKLtjpnPeUdK7h0yzXGmyBTypknlkCvHFBqfX9YlorEiMM6Dnq/5atfHkw==", + "dev": true + }, "import-local": { "version": "3.1.0", "resolved": "https://registry.npmjs.org/import-local/-/import-local-3.1.0.tgz", @@ -10941,6 +11449,12 @@ } } }, + "jju": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/jju/-/jju-1.4.0.tgz", + "integrity": "sha512-8wb9Yw966OSxApiCt0K3yNJL8pnNeIv+OEq2YMidz4FKP6nonSRoOXc80iXY4JaN2FC11B9qsNmDsm+ZOfMROA==", + "dev": true + }, "js-tokens": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/js-tokens/-/js-tokens-4.0.0.tgz", @@ -10987,6 +11501,15 @@ "integrity": "sha512-XmOWe7eyHYH14cLdVPoyg+GOH3rYX++KpzrylJwSW98t3Nk+U8XOl8FWKOgwtzdb8lXGf6zYwDUzeHMWfxasyg==", "dev": true }, + "jsonfile": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/jsonfile/-/jsonfile-4.0.0.tgz", + "integrity": "sha512-m6F1R3z8jjlf2imQHS2Qez5sjKWQzbuuhuJ/FKYFRZvPE3PuHcSMVZzfsLhGVOkfd20obL5SWEBew5ShlquNxg==", + "dev": true, + "requires": { + "graceful-fs": "^4.1.6" + } + }, "kleur": { "version": "3.0.3", "resolved": "https://registry.npmjs.org/kleur/-/kleur-3.0.3.tgz", @@ -11024,6 +11547,24 @@ "p-locate": "^5.0.0" } }, + "lodash": { + "version": "4.17.21", + "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.21.tgz", + "integrity": "sha512-v2kDEe57lecTulaDIuNTPy3Ry4gLGJ6Z1O3vE1krgXZNrsQ+LFTGHVxVjcXPs17LhbZVGedAJv8XZ1tvj5FvSg==", + "dev": true + }, + "lodash.get": { + "version": "4.4.2", + "resolved": "https://registry.npmjs.org/lodash.get/-/lodash.get-4.4.2.tgz", + "integrity": "sha512-z+Uw/vLuy6gQe8cfaFWD7p0wVv8fJl3mbzXh33RS+0oW2wvUqiRXiQ69gLWSLpgB5/6sU+r6BlQR0MBILadqTQ==", + "dev": true + }, + "lodash.isequal": { + "version": "4.5.0", + "resolved": "https://registry.npmjs.org/lodash.isequal/-/lodash.isequal-4.5.0.tgz", + "integrity": "sha512-pDo3lu8Jhfjqls6GkMgpahsF9kCyayhgykjyLMNFTKWrpVdAQtYyB4muAMWozBB4ig/dtWAmsMxLEI8wuz+DYQ==", + "dev": true + }, "lodash.memoize": { "version": "4.1.2", "resolved": "https://registry.npmjs.org/lodash.memoize/-/lodash.memoize-4.1.2.tgz", @@ -11566,6 +12107,12 @@ } } }, + "string-argv": { + "version": "0.3.2", + "resolved": "https://registry.npmjs.org/string-argv/-/string-argv-0.3.2.tgz", + "integrity": "sha512-aqD2Q0144Z+/RqG52NeHEkZauTAUWJO8c6yTftGJKO3Tja5tUgIfmIl6kExvhtxSDP7fXB6DvzkfMpCd/F3G+Q==", + "dev": true + }, "string-length": { "version": "4.0.2", "resolved": "https://registry.npmjs.org/string-length/-/string-length-4.0.2.tgz", @@ -11767,6 +12314,12 @@ "integrity": "sha512-1FXk9E2Hm+QzZQ7z+McJiHL4NW1F2EzMu9Nq9i3zAaGqibafqYwCVU6WyWAuyQRRzOlxou8xZSyXLEN8oKj24g==", "dev": true }, + "universalify": { + "version": "0.1.2", + "resolved": "https://registry.npmjs.org/universalify/-/universalify-0.1.2.tgz", + "integrity": "sha512-rBJeI5CXAlmy1pV+617WB9J63U6XcazHHF2f2dbJix4XzpUF0RS3Zbj0FGIOCAva5P/d/GBOYaACQ1w+0azUkg==", + "dev": true + }, "update-browserslist-db": { "version": "1.0.10", "resolved": "https://registry.npmjs.org/update-browserslist-db/-/update-browserslist-db-1.0.10.tgz", @@ -11820,6 +12373,12 @@ } } }, + "validator": { + "version": "13.11.0", + "resolved": "https://registry.npmjs.org/validator/-/validator-13.11.0.tgz", + "integrity": "sha512-Ii+sehpSfZy+At5nPdnyMhx78fEoPDkR2XW/zimHEL3MyGJQOCQ7WeP20jPYRz7ZCpcKLB21NxuXHF3bxjStBQ==", + "dev": true + }, "vows": { "version": "0.8.3", "resolved": "https://registry.npmjs.org/vows/-/vows-0.8.3.tgz", @@ -11937,6 +12496,27 @@ "resolved": "https://registry.npmjs.org/yocto-queue/-/yocto-queue-0.1.0.tgz", "integrity": "sha512-rVksvsnNCdJ/ohGc6xgPwyN8eheCxsiLM8mxuE/t/mOVqJewPuO1miLpTHQiRgTKCLexL4MeAFVagts7HmNZ2Q==", "dev": true + }, + "z-schema": { + "version": "5.0.5", + "resolved": "https://registry.npmjs.org/z-schema/-/z-schema-5.0.5.tgz", + "integrity": "sha512-D7eujBWkLa3p2sIpJA0d1pr7es+a7m0vFAnZLlCEKq/Ij2k0MLi9Br2UPxoxdYystm5K1yeBGzub0FlYUEWj2Q==", + "dev": true, + "requires": { + "commander": "^9.4.1", + "lodash.get": "^4.4.2", + "lodash.isequal": "^4.5.0", + "validator": "^13.7.0" + }, + "dependencies": { + "commander": { + "version": "9.5.0", + "resolved": "https://registry.npmjs.org/commander/-/commander-9.5.0.tgz", + "integrity": "sha512-KRs7WVDKg86PWiuAqhDrAQnTXZKraVcCc6vFdL14qrZ/DcWwuRo7VoiYXalXO7S5GKpqYiVEwCbgFDfxNHKJBQ==", + "dev": true, + "optional": true + } + } } } }