Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(deps-dev): bump typedoc to 0.23.23 #4515

Merged
merged 11 commits into from
Mar 14, 2023
Merged
  •  
  •  
  •  
31 changes: 16 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -330,13 +330,13 @@ Many AWS operations return paginated results when the response object is too lar

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

- 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.
- 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.
- await expressions and `for await (x of y)` statements are allowed.
- The behavior of `yield*` is modified to support delegation to async iterables.

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.

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.
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.

#### Example Pagination Usage

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

## Release Cadence

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

## Stability of Modular Packages

|Package name|containing folder|API controlled by|stability|
|---|---|---|---|
|@aws-sdk/client-* Commands|clients|AWS service teams|public/stable|
|@aws-sdk/client-* Clients|clients|AWS SDK JS team|public/stable|
|@aws-sdk/lib-*|lib|AWS SDK JS team|public/stable|
|@aws-sdk/*-signer|packages|AWS SDK JS team|public/stable|
|@aws-sdk/middleware-stack|packages|AWS SDK JS team|public/stable|
|remaining @aws-sdk/*|packages|AWS SDK JS team|internal|
| Package name | containing folder | API controlled by | stability |
| --------------------------- | ----------------- | ----------------- | ------------- |
| @aws-sdk/client-\* Commands | clients | AWS service teams | public/stable |
| @aws-sdk/client-\* Clients | clients | AWS SDK JS team | public/stable |
| @aws-sdk/lib-\* | lib | AWS SDK JS team | public/stable |
| @aws-sdk/\*-signer | packages | AWS SDK JS team | public/stable |
| @aws-sdk/middleware-stack | packages | AWS SDK JS team | public/stable |
| remaining @aws-sdk/\* | packages | AWS SDK JS team | internal |

Additional notes:

- internal does not mean a package or interface is constantly changing
or being actively worked on. It means it is subject to change without any
notice period. The changes are included in the release notes.
or being actively worked on. It means it is subject to change without any
notice period. The changes are included in the release notes.
- public interfaces such as client configuration are also subject to change
in exceptional cases. We will try to undergo a deprecation period with
an advance notice.
in exceptional cases. We will try to undergo a deprecation period with
an advance notice.

## Known Issues

Expand Down
7 changes: 1 addition & 6 deletions clients/client-accessanalyzer/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -63,14 +63,9 @@
"concurrently": "7.0.0",
"downlevel-dts": "0.10.1",
"rimraf": "3.0.2",
"typedoc": "0.19.2",
"typedoc": "0.23.23",
"typescript": "~4.6.2"
},
"overrides": {
"typedoc": {
"typescript": "~4.6.2"
}
},
"engines": {
"node": ">=14.0.0"
},
Expand Down
5 changes: 4 additions & 1 deletion clients/client-accessanalyzer/typedoc.json
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
{
"extends": "../../typedoc.client.json"
"extends": ["../../typedoc.client.json"],
"entryPoints": ["src/index.ts"],
"out": "docs",
"readme": "README.md"
trivikr marked this conversation as resolved.
Show resolved Hide resolved
}
7 changes: 1 addition & 6 deletions clients/client-account/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -61,14 +61,9 @@
"concurrently": "7.0.0",
"downlevel-dts": "0.10.1",
"rimraf": "3.0.2",
"typedoc": "0.19.2",
"typedoc": "0.23.23",
"typescript": "~4.6.2"
},
"overrides": {
"typedoc": {
"typescript": "~4.6.2"
}
},
"engines": {
"node": ">=14.0.0"
},
Expand Down
5 changes: 4 additions & 1 deletion clients/client-account/typedoc.json
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
{
"extends": "../../typedoc.client.json"
"extends": ["../../typedoc.client.json"],
"entryPoints": ["src/index.ts"],
"out": "docs",
"readme": "README.md"
}
7 changes: 1 addition & 6 deletions clients/client-acm-pca/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -62,14 +62,9 @@
"concurrently": "7.0.0",
"downlevel-dts": "0.10.1",
"rimraf": "3.0.2",
"typedoc": "0.19.2",
"typedoc": "0.23.23",
"typescript": "~4.6.2"
},
"overrides": {
"typedoc": {
"typescript": "~4.6.2"
}
},
"engines": {
"node": ">=14.0.0"
},
Expand Down
5 changes: 4 additions & 1 deletion clients/client-acm-pca/typedoc.json
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
{
"extends": "../../typedoc.client.json"
"extends": ["../../typedoc.client.json"],
"entryPoints": ["src/index.ts"],
"out": "docs",
"readme": "README.md"
}
7 changes: 1 addition & 6 deletions clients/client-acm/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -62,14 +62,9 @@
"concurrently": "7.0.0",
"downlevel-dts": "0.10.1",
"rimraf": "3.0.2",
"typedoc": "0.19.2",
"typedoc": "0.23.23",
"typescript": "~4.6.2"
},
"overrides": {
"typedoc": {
"typescript": "~4.6.2"
}
},
"engines": {
"node": ">=14.0.0"
},
Expand Down
5 changes: 4 additions & 1 deletion clients/client-acm/typedoc.json
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
{
"extends": "../../typedoc.client.json"
"extends": ["../../typedoc.client.json"],
"entryPoints": ["src/index.ts"],
"out": "docs",
"readme": "README.md"
}
7 changes: 1 addition & 6 deletions clients/client-alexa-for-business/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -63,14 +63,9 @@
"concurrently": "7.0.0",
"downlevel-dts": "0.10.1",
"rimraf": "3.0.2",
"typedoc": "0.19.2",
"typedoc": "0.23.23",
"typescript": "~4.6.2"
},
"overrides": {
"typedoc": {
"typescript": "~4.6.2"
}
},
"engines": {
"node": ">=14.0.0"
},
Expand Down
5 changes: 4 additions & 1 deletion clients/client-alexa-for-business/typedoc.json
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
{
"extends": "../../typedoc.client.json"
"extends": ["../../typedoc.client.json"],
"entryPoints": ["src/index.ts"],
"out": "docs",
"readme": "README.md"
}
7 changes: 1 addition & 6 deletions clients/client-amp/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -64,14 +64,9 @@
"concurrently": "7.0.0",
"downlevel-dts": "0.10.1",
"rimraf": "3.0.2",
"typedoc": "0.19.2",
"typedoc": "0.23.23",
"typescript": "~4.6.2"
},
"overrides": {
"typedoc": {
"typescript": "~4.6.2"
}
},
"engines": {
"node": ">=14.0.0"
},
Expand Down
5 changes: 4 additions & 1 deletion clients/client-amp/typedoc.json
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
{
"extends": "../../typedoc.client.json"
"extends": ["../../typedoc.client.json"],
"entryPoints": ["src/index.ts"],
"out": "docs",
"readme": "README.md"
}
7 changes: 1 addition & 6 deletions clients/client-amplify/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -61,14 +61,9 @@
"concurrently": "7.0.0",
"downlevel-dts": "0.10.1",
"rimraf": "3.0.2",
"typedoc": "0.19.2",
"typedoc": "0.23.23",
"typescript": "~4.6.2"
},
"overrides": {
"typedoc": {
"typescript": "~4.6.2"
}
},
"engines": {
"node": ">=14.0.0"
},
Expand Down
5 changes: 4 additions & 1 deletion clients/client-amplify/typedoc.json
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
{
"extends": "../../typedoc.client.json"
"extends": ["../../typedoc.client.json"],
"entryPoints": ["src/index.ts"],
"out": "docs",
"readme": "README.md"
}
7 changes: 1 addition & 6 deletions clients/client-amplifybackend/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -61,14 +61,9 @@
"concurrently": "7.0.0",
"downlevel-dts": "0.10.1",
"rimraf": "3.0.2",
"typedoc": "0.19.2",
"typedoc": "0.23.23",
"typescript": "~4.6.2"
},
"overrides": {
"typedoc": {
"typescript": "~4.6.2"
}
},
"engines": {
"node": ">=14.0.0"
},
Expand Down
5 changes: 4 additions & 1 deletion clients/client-amplifybackend/typedoc.json
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
{
"extends": "../../typedoc.client.json"
"extends": ["../../typedoc.client.json"],
"entryPoints": ["src/index.ts"],
"out": "docs",
"readme": "README.md"
}
7 changes: 1 addition & 6 deletions clients/client-amplifyuibuilder/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -63,14 +63,9 @@
"concurrently": "7.0.0",
"downlevel-dts": "0.10.1",
"rimraf": "3.0.2",
"typedoc": "0.19.2",
"typedoc": "0.23.23",
"typescript": "~4.6.2"
},
"overrides": {
"typedoc": {
"typescript": "~4.6.2"
}
},
"engines": {
"node": ">=14.0.0"
},
Expand Down
5 changes: 4 additions & 1 deletion clients/client-amplifyuibuilder/typedoc.json
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
{
"extends": "../../typedoc.client.json"
"extends": ["../../typedoc.client.json"],
"entryPoints": ["src/index.ts"],
"out": "docs",
"readme": "README.md"
}
7 changes: 1 addition & 6 deletions clients/client-api-gateway/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -62,14 +62,9 @@
"concurrently": "7.0.0",
"downlevel-dts": "0.10.1",
"rimraf": "3.0.2",
"typedoc": "0.19.2",
"typedoc": "0.23.23",
"typescript": "~4.6.2"
},
"overrides": {
"typedoc": {
"typescript": "~4.6.2"
}
},
"engines": {
"node": ">=14.0.0"
},
Expand Down
5 changes: 4 additions & 1 deletion clients/client-api-gateway/typedoc.json
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
{
"extends": "../../typedoc.client.json"
"extends": ["../../typedoc.client.json"],
"entryPoints": ["src/index.ts"],
"out": "docs",
"readme": "README.md"
}
7 changes: 1 addition & 6 deletions clients/client-apigatewaymanagementapi/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -61,14 +61,9 @@
"concurrently": "7.0.0",
"downlevel-dts": "0.10.1",
"rimraf": "3.0.2",
"typedoc": "0.19.2",
"typedoc": "0.23.23",
"typescript": "~4.6.2"
},
"overrides": {
"typedoc": {
"typescript": "~4.6.2"
}
},
"engines": {
"node": ">=14.0.0"
},
Expand Down
5 changes: 4 additions & 1 deletion clients/client-apigatewaymanagementapi/typedoc.json
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
{
"extends": "../../typedoc.client.json"
"extends": ["../../typedoc.client.json"],
"entryPoints": ["src/index.ts"],
"out": "docs",
"readme": "README.md"
}
7 changes: 1 addition & 6 deletions clients/client-apigatewayv2/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -61,14 +61,9 @@
"concurrently": "7.0.0",
"downlevel-dts": "0.10.1",
"rimraf": "3.0.2",
"typedoc": "0.19.2",
"typedoc": "0.23.23",
"typescript": "~4.6.2"
},
"overrides": {
"typedoc": {
"typescript": "~4.6.2"
}
},
"engines": {
"node": ">=14.0.0"
},
Expand Down
5 changes: 4 additions & 1 deletion clients/client-apigatewayv2/typedoc.json
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
{
"extends": "../../typedoc.client.json"
"extends": ["../../typedoc.client.json"],
"entryPoints": ["src/index.ts"],
"out": "docs",
"readme": "README.md"
}
7 changes: 1 addition & 6 deletions clients/client-app-mesh/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -63,14 +63,9 @@
"concurrently": "7.0.0",
"downlevel-dts": "0.10.1",
"rimraf": "3.0.2",
"typedoc": "0.19.2",
"typedoc": "0.23.23",
"typescript": "~4.6.2"
},
"overrides": {
"typedoc": {
"typescript": "~4.6.2"
}
},
"engines": {
"node": ">=14.0.0"
},
Expand Down
5 changes: 4 additions & 1 deletion clients/client-app-mesh/typedoc.json
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
{
"extends": "../../typedoc.client.json"
"extends": ["../../typedoc.client.json"],
"entryPoints": ["src/index.ts"],
"out": "docs",
"readme": "README.md"
}
7 changes: 1 addition & 6 deletions clients/client-appconfig/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -61,14 +61,9 @@
"concurrently": "7.0.0",
"downlevel-dts": "0.10.1",
"rimraf": "3.0.2",
"typedoc": "0.19.2",
"typedoc": "0.23.23",
"typescript": "~4.6.2"
},
"overrides": {
"typedoc": {
"typescript": "~4.6.2"
}
},
"engines": {
"node": ">=14.0.0"
},
Expand Down
5 changes: 4 additions & 1 deletion clients/client-appconfig/typedoc.json
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
{
"extends": "../../typedoc.client.json"
"extends": ["../../typedoc.client.json"],
"entryPoints": ["src/index.ts"],
"out": "docs",
"readme": "README.md"
}