Skip to content

Commit 6604067

Browse files
MYoung25MYoung25
authored
chore(deps-dev): bump typedoc to 0.23.23 (#4515)
* chore(bump-typedoc): bump typedoc to ^0.23.23 * feat(add-footer): add footer to core theme * chore(pin-typedoc): pin typedoc to 0.23.23 * fix(remove-private-docs): and format typedoc.json * fix(urls): mimic historic client urls * fix(revert): revert to exclude ruleset and mimic current navigation experience * fix(docs): pin typedoc in private/* * fix(theme): redirect regression and add border to classes index section * fix(theme): slight modification of border in theme
1 parent e77e115 commit 6604067

File tree

845 files changed

+3192
-3049
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

845 files changed

+3192
-3049
lines changed

‎README.md

+16-15
Original file line numberDiff line numberDiff line change
@@ -330,13 +330,13 @@ Many AWS operations return paginated results when the response object is too lar
330330

331331
In AWS SDK for JavaScript v3 we’ve improved pagination using async generator functions, which are similar to generator functions, with the following differences:
332332

333-
- When called, async generator functions return an object, an async generator whose methods (`next`, `throw`, and `return`) return promises for { `value`, `done` }, instead of directly returning { `value`, `done` }. This automatically makes the returned async generator objects async iterators.
333+
- When called, async generator functions return an object, an async generator whose methods (`next`, `throw`, and `return`) return promises for `{ `value`, `done` }`, instead of directly returning `{ `value`, `done` }`. This automatically makes the returned async generator objects async iterators.
334334
- await expressions and `for await (x of y)` statements are allowed.
335335
- The behavior of `yield*` is modified to support delegation to async iterables.
336336

337337
The Async Iterators were added in the ES2018 iteration of JavaScript. They are supported by Node.js 10.x+ and by all modern browsers, including Chrome 63+, Firefox 57+, Safari 11.1+, and Edge 79+. If you’re using TypeScript v2.3+, you can compile Async Iterators to older versions of JavaScript.
338338

339-
An async iterator is much like an iterator, except that its `next()` method returns a promise for a { `value`, `done` } pair. As an implicit aspect of the Async Iteration protocol, the next promise is not requested until the previous one resolves. This is a simple, yet a very powerful pattern.
339+
An async iterator is much like an iterator, except that its `next()` method returns a promise for a `{ `value`, `done` }` pair. As an implicit aspect of the Async Iteration protocol, the next promise is not requested until the previous one resolves. This is a simple, yet a very powerful pattern.
340340

341341
#### Example Pagination Usage
342342

@@ -511,27 +511,28 @@ For a full middleware stack deep dive please check out our [blog post](https://a
511511

512512
## Release Cadence
513513

514-
Our releases usually happen once per weekday. Each release increments the
514+
Our releases usually happen once per weekday. Each release increments the
515515
minor version, e.g. 3.200.0 -> 3.201.0.
516516

517517
## Stability of Modular Packages
518518

519-
|Package name|containing folder|API controlled by|stability|
520-
|---|---|---|---|
521-
|@aws-sdk/client-* Commands|clients|AWS service teams|public/stable|
522-
|@aws-sdk/client-* Clients|clients|AWS SDK JS team|public/stable|
523-
|@aws-sdk/lib-*|lib|AWS SDK JS team|public/stable|
524-
|@aws-sdk/*-signer|packages|AWS SDK JS team|public/stable|
525-
|@aws-sdk/middleware-stack|packages|AWS SDK JS team|public/stable|
526-
|remaining @aws-sdk/*|packages|AWS SDK JS team|internal|
519+
| Package name | containing folder | API controlled by | stability |
520+
| --------------------------- | ----------------- | ----------------- | ------------- |
521+
| @aws-sdk/client-\* Commands | clients | AWS service teams | public/stable |
522+
| @aws-sdk/client-\* Clients | clients | AWS SDK JS team | public/stable |
523+
| @aws-sdk/lib-\* | lib | AWS SDK JS team | public/stable |
524+
| @aws-sdk/\*-signer | packages | AWS SDK JS team | public/stable |
525+
| @aws-sdk/middleware-stack | packages | AWS SDK JS team | public/stable |
526+
| remaining @aws-sdk/\* | packages | AWS SDK JS team | internal |
527527

528528
Additional notes:
529+
529530
- internal does not mean a package or interface is constantly changing
530-
or being actively worked on. It means it is subject to change without any
531-
notice period. The changes are included in the release notes.
531+
or being actively worked on. It means it is subject to change without any
532+
notice period. The changes are included in the release notes.
532533
- public interfaces such as client configuration are also subject to change
533-
in exceptional cases. We will try to undergo a deprecation period with
534-
an advance notice.
534+
in exceptional cases. We will try to undergo a deprecation period with
535+
an advance notice.
535536

536537
## Known Issues
537538

‎clients/client-accessanalyzer/package.json

+1-6
Original file line numberDiff line numberDiff line change
@@ -63,14 +63,9 @@
6363
"concurrently": "7.0.0",
6464
"downlevel-dts": "0.10.1",
6565
"rimraf": "3.0.2",
66-
"typedoc": "0.19.2",
66+
"typedoc": "0.23.23",
6767
"typescript": "~4.6.2"
6868
},
69-
"overrides": {
70-
"typedoc": {
71-
"typescript": "~4.6.2"
72-
}
73-
},
7469
"engines": {
7570
"node": ">=14.0.0"
7671
},

‎clients/client-accessanalyzer/typedoc.json

+4-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
11
{
2-
"extends": "../../typedoc.client.json"
2+
"extends": ["../../typedoc.client.json"],
3+
"entryPoints": ["src/index.ts"],
4+
"out": "docs",
5+
"readme": "README.md"
36
}

‎clients/client-account/package.json

+1-6
Original file line numberDiff line numberDiff line change
@@ -61,14 +61,9 @@
6161
"concurrently": "7.0.0",
6262
"downlevel-dts": "0.10.1",
6363
"rimraf": "3.0.2",
64-
"typedoc": "0.19.2",
64+
"typedoc": "0.23.23",
6565
"typescript": "~4.6.2"
6666
},
67-
"overrides": {
68-
"typedoc": {
69-
"typescript": "~4.6.2"
70-
}
71-
},
7267
"engines": {
7368
"node": ">=14.0.0"
7469
},

‎clients/client-account/typedoc.json

+4-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
11
{
2-
"extends": "../../typedoc.client.json"
2+
"extends": ["../../typedoc.client.json"],
3+
"entryPoints": ["src/index.ts"],
4+
"out": "docs",
5+
"readme": "README.md"
36
}

‎clients/client-acm-pca/package.json

+1-6
Original file line numberDiff line numberDiff line change
@@ -62,14 +62,9 @@
6262
"concurrently": "7.0.0",
6363
"downlevel-dts": "0.10.1",
6464
"rimraf": "3.0.2",
65-
"typedoc": "0.19.2",
65+
"typedoc": "0.23.23",
6666
"typescript": "~4.6.2"
6767
},
68-
"overrides": {
69-
"typedoc": {
70-
"typescript": "~4.6.2"
71-
}
72-
},
7368
"engines": {
7469
"node": ">=14.0.0"
7570
},

‎clients/client-acm-pca/typedoc.json

+4-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
11
{
2-
"extends": "../../typedoc.client.json"
2+
"extends": ["../../typedoc.client.json"],
3+
"entryPoints": ["src/index.ts"],
4+
"out": "docs",
5+
"readme": "README.md"
36
}

‎clients/client-acm/package.json

+1-6
Original file line numberDiff line numberDiff line change
@@ -62,14 +62,9 @@
6262
"concurrently": "7.0.0",
6363
"downlevel-dts": "0.10.1",
6464
"rimraf": "3.0.2",
65-
"typedoc": "0.19.2",
65+
"typedoc": "0.23.23",
6666
"typescript": "~4.6.2"
6767
},
68-
"overrides": {
69-
"typedoc": {
70-
"typescript": "~4.6.2"
71-
}
72-
},
7368
"engines": {
7469
"node": ">=14.0.0"
7570
},

‎clients/client-acm/typedoc.json

+4-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
11
{
2-
"extends": "../../typedoc.client.json"
2+
"extends": ["../../typedoc.client.json"],
3+
"entryPoints": ["src/index.ts"],
4+
"out": "docs",
5+
"readme": "README.md"
36
}

‎clients/client-alexa-for-business/package.json

+1-6
Original file line numberDiff line numberDiff line change
@@ -63,14 +63,9 @@
6363
"concurrently": "7.0.0",
6464
"downlevel-dts": "0.10.1",
6565
"rimraf": "3.0.2",
66-
"typedoc": "0.19.2",
66+
"typedoc": "0.23.23",
6767
"typescript": "~4.6.2"
6868
},
69-
"overrides": {
70-
"typedoc": {
71-
"typescript": "~4.6.2"
72-
}
73-
},
7469
"engines": {
7570
"node": ">=14.0.0"
7671
},

‎clients/client-alexa-for-business/typedoc.json

+4-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
11
{
2-
"extends": "../../typedoc.client.json"
2+
"extends": ["../../typedoc.client.json"],
3+
"entryPoints": ["src/index.ts"],
4+
"out": "docs",
5+
"readme": "README.md"
36
}

‎clients/client-amp/package.json

+1-6
Original file line numberDiff line numberDiff line change
@@ -64,14 +64,9 @@
6464
"concurrently": "7.0.0",
6565
"downlevel-dts": "0.10.1",
6666
"rimraf": "3.0.2",
67-
"typedoc": "0.19.2",
67+
"typedoc": "0.23.23",
6868
"typescript": "~4.6.2"
6969
},
70-
"overrides": {
71-
"typedoc": {
72-
"typescript": "~4.6.2"
73-
}
74-
},
7570
"engines": {
7671
"node": ">=14.0.0"
7772
},

‎clients/client-amp/typedoc.json

+4-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
11
{
2-
"extends": "../../typedoc.client.json"
2+
"extends": ["../../typedoc.client.json"],
3+
"entryPoints": ["src/index.ts"],
4+
"out": "docs",
5+
"readme": "README.md"
36
}

‎clients/client-amplify/package.json

+1-6
Original file line numberDiff line numberDiff line change
@@ -61,14 +61,9 @@
6161
"concurrently": "7.0.0",
6262
"downlevel-dts": "0.10.1",
6363
"rimraf": "3.0.2",
64-
"typedoc": "0.19.2",
64+
"typedoc": "0.23.23",
6565
"typescript": "~4.6.2"
6666
},
67-
"overrides": {
68-
"typedoc": {
69-
"typescript": "~4.6.2"
70-
}
71-
},
7267
"engines": {
7368
"node": ">=14.0.0"
7469
},

‎clients/client-amplify/typedoc.json

+4-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
11
{
2-
"extends": "../../typedoc.client.json"
2+
"extends": ["../../typedoc.client.json"],
3+
"entryPoints": ["src/index.ts"],
4+
"out": "docs",
5+
"readme": "README.md"
36
}

‎clients/client-amplifybackend/package.json

+1-6
Original file line numberDiff line numberDiff line change
@@ -61,14 +61,9 @@
6161
"concurrently": "7.0.0",
6262
"downlevel-dts": "0.10.1",
6363
"rimraf": "3.0.2",
64-
"typedoc": "0.19.2",
64+
"typedoc": "0.23.23",
6565
"typescript": "~4.6.2"
6666
},
67-
"overrides": {
68-
"typedoc": {
69-
"typescript": "~4.6.2"
70-
}
71-
},
7267
"engines": {
7368
"node": ">=14.0.0"
7469
},

‎clients/client-amplifybackend/typedoc.json

+4-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
11
{
2-
"extends": "../../typedoc.client.json"
2+
"extends": ["../../typedoc.client.json"],
3+
"entryPoints": ["src/index.ts"],
4+
"out": "docs",
5+
"readme": "README.md"
36
}

‎clients/client-amplifyuibuilder/package.json

+1-6
Original file line numberDiff line numberDiff line change
@@ -63,14 +63,9 @@
6363
"concurrently": "7.0.0",
6464
"downlevel-dts": "0.10.1",
6565
"rimraf": "3.0.2",
66-
"typedoc": "0.19.2",
66+
"typedoc": "0.23.23",
6767
"typescript": "~4.6.2"
6868
},
69-
"overrides": {
70-
"typedoc": {
71-
"typescript": "~4.6.2"
72-
}
73-
},
7469
"engines": {
7570
"node": ">=14.0.0"
7671
},

‎clients/client-amplifyuibuilder/typedoc.json

+4-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
11
{
2-
"extends": "../../typedoc.client.json"
2+
"extends": ["../../typedoc.client.json"],
3+
"entryPoints": ["src/index.ts"],
4+
"out": "docs",
5+
"readme": "README.md"
36
}

‎clients/client-api-gateway/package.json

+1-6
Original file line numberDiff line numberDiff line change
@@ -62,14 +62,9 @@
6262
"concurrently": "7.0.0",
6363
"downlevel-dts": "0.10.1",
6464
"rimraf": "3.0.2",
65-
"typedoc": "0.19.2",
65+
"typedoc": "0.23.23",
6666
"typescript": "~4.6.2"
6767
},
68-
"overrides": {
69-
"typedoc": {
70-
"typescript": "~4.6.2"
71-
}
72-
},
7368
"engines": {
7469
"node": ">=14.0.0"
7570
},

‎clients/client-api-gateway/typedoc.json

+4-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
11
{
2-
"extends": "../../typedoc.client.json"
2+
"extends": ["../../typedoc.client.json"],
3+
"entryPoints": ["src/index.ts"],
4+
"out": "docs",
5+
"readme": "README.md"
36
}

‎clients/client-apigatewaymanagementapi/package.json

+1-6
Original file line numberDiff line numberDiff line change
@@ -61,14 +61,9 @@
6161
"concurrently": "7.0.0",
6262
"downlevel-dts": "0.10.1",
6363
"rimraf": "3.0.2",
64-
"typedoc": "0.19.2",
64+
"typedoc": "0.23.23",
6565
"typescript": "~4.6.2"
6666
},
67-
"overrides": {
68-
"typedoc": {
69-
"typescript": "~4.6.2"
70-
}
71-
},
7267
"engines": {
7368
"node": ">=14.0.0"
7469
},

‎clients/client-apigatewaymanagementapi/typedoc.json

+4-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
11
{
2-
"extends": "../../typedoc.client.json"
2+
"extends": ["../../typedoc.client.json"],
3+
"entryPoints": ["src/index.ts"],
4+
"out": "docs",
5+
"readme": "README.md"
36
}

‎clients/client-apigatewayv2/package.json

+1-6
Original file line numberDiff line numberDiff line change
@@ -61,14 +61,9 @@
6161
"concurrently": "7.0.0",
6262
"downlevel-dts": "0.10.1",
6363
"rimraf": "3.0.2",
64-
"typedoc": "0.19.2",
64+
"typedoc": "0.23.23",
6565
"typescript": "~4.6.2"
6666
},
67-
"overrides": {
68-
"typedoc": {
69-
"typescript": "~4.6.2"
70-
}
71-
},
7267
"engines": {
7368
"node": ">=14.0.0"
7469
},

‎clients/client-apigatewayv2/typedoc.json

+4-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
11
{
2-
"extends": "../../typedoc.client.json"
2+
"extends": ["../../typedoc.client.json"],
3+
"entryPoints": ["src/index.ts"],
4+
"out": "docs",
5+
"readme": "README.md"
36
}

‎clients/client-app-mesh/package.json

+1-6
Original file line numberDiff line numberDiff line change
@@ -63,14 +63,9 @@
6363
"concurrently": "7.0.0",
6464
"downlevel-dts": "0.10.1",
6565
"rimraf": "3.0.2",
66-
"typedoc": "0.19.2",
66+
"typedoc": "0.23.23",
6767
"typescript": "~4.6.2"
6868
},
69-
"overrides": {
70-
"typedoc": {
71-
"typescript": "~4.6.2"
72-
}
73-
},
7469
"engines": {
7570
"node": ">=14.0.0"
7671
},

‎clients/client-app-mesh/typedoc.json

+4-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
11
{
2-
"extends": "../../typedoc.client.json"
2+
"extends": ["../../typedoc.client.json"],
3+
"entryPoints": ["src/index.ts"],
4+
"out": "docs",
5+
"readme": "README.md"
36
}

‎clients/client-appconfig/package.json

+1-6
Original file line numberDiff line numberDiff line change
@@ -61,14 +61,9 @@
6161
"concurrently": "7.0.0",
6262
"downlevel-dts": "0.10.1",
6363
"rimraf": "3.0.2",
64-
"typedoc": "0.19.2",
64+
"typedoc": "0.23.23",
6565
"typescript": "~4.6.2"
6666
},
67-
"overrides": {
68-
"typedoc": {
69-
"typescript": "~4.6.2"
70-
}
71-
},
7267
"engines": {
7368
"node": ">=14.0.0"
7469
},

‎clients/client-appconfig/typedoc.json

+4-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
11
{
2-
"extends": "../../typedoc.client.json"
2+
"extends": ["../../typedoc.client.json"],
3+
"entryPoints": ["src/index.ts"],
4+
"out": "docs",
5+
"readme": "README.md"
36
}

0 commit comments

Comments
 (0)