@aws-sdk/client-appconfig 3.1007.0 → 3.1009.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +26 -46
  2. package/package.json +35 -35
package/README.md CHANGED
@@ -158,8 +158,9 @@ by directly calling the <a href="https://docs.aws.amazon.com/appconfig/2019-10-0
158
158
  Guide</a>.</p>
159
159
 
160
160
  ## Installing
161
- To install this package, simply type add or install @aws-sdk/client-appconfig
162
- using your favorite package manager:
161
+
162
+ To install this package, use the CLI of your favorite package manager:
163
+
163
164
  - `npm install @aws-sdk/client-appconfig`
164
165
  - `yarn add @aws-sdk/client-appconfig`
165
166
  - `pnpm add @aws-sdk/client-appconfig`
@@ -184,15 +185,15 @@ import { AppConfigClient, ListApplicationsCommand } from "@aws-sdk/client-appcon
184
185
 
185
186
  ### Usage
186
187
 
187
- To send a request, you:
188
+ To send a request:
188
189
 
189
- - Initiate client with configuration (e.g. credentials, region).
190
- - Initiate command with input parameters.
191
- - Call `send` operation on client with command object as input.
192
- - If you are using a custom http handler, you may call `destroy()` to close open connections.
190
+ - Instantiate a client with configuration (e.g. credentials, region).
191
+ - See [docs/CLIENTS](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/CLIENTS.md) for configuration details.
192
+ - See [@aws-sdk/config](https://github.com/aws/aws-sdk-js-v3/blob/main/packages/config/README.md) for additional options.
193
+ - Instantiate a command with input parameters.
194
+ - Call the `send` operation on the client, providing the command object as input.
193
195
 
194
196
  ```js
195
- // a client can be shared by different commands.
196
197
  const client = new AppConfigClient({ region: "REGION" });
197
198
 
198
199
  const params = { /** input parameters */ };
@@ -201,7 +202,7 @@ const command = new ListApplicationsCommand(params);
201
202
 
202
203
  #### Async/await
203
204
 
204
- We recommend using [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
205
+ We recommend using the [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
205
206
  operator to wait for the promise returned by send operation as follows:
206
207
 
207
208
  ```js
@@ -216,26 +217,9 @@ try {
216
217
  }
217
218
  ```
218
219
 
219
- Async-await is clean, concise, intuitive, easy to debug and has better error handling
220
- as compared to using Promise chains or callbacks.
221
-
222
220
  #### Promises
223
221
 
224
- You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining)
225
- to execute send operation.
226
-
227
- ```js
228
- client.send(command).then(
229
- (data) => {
230
- // process data.
231
- },
232
- (error) => {
233
- // error handling.
234
- }
235
- );
236
- ```
237
-
238
- Promises can also be called using `.catch()` and `.finally()` as follows:
222
+ You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining).
239
223
 
240
224
  ```js
241
225
  client
@@ -251,27 +235,21 @@ client
251
235
  });
252
236
  ```
253
237
 
254
- #### Callbacks
255
-
256
- We do not recommend using callbacks because of [callback hell](http://callbackhell.com/),
257
- but they are supported by the send operation.
238
+ #### Aggregated client
258
239
 
259
- ```js
260
- // callbacks.
261
- client.send(command, (err, data) => {
262
- // process err and data.
263
- });
264
- ```
240
+ The aggregated client class is exported from the same package, but without the "Client" suffix.
265
241
 
266
- #### v2 compatible style
242
+ `AppConfig` extends `AppConfigClient` and additionally supports all operations, waiters, and paginators as methods.
243
+ This style may be familiar to you from the AWS SDK for JavaScript v2.
267
244
 
268
- The client can also send requests using v2 compatible style.
269
- However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post
270
- on [modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/)
245
+ If you are bundling the AWS SDK, we recommend using only the bare-bones client (`AppConfigClient`).
246
+ More details are in the blog post on
247
+ [modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/).
271
248
 
272
249
  ```ts
273
- import * as AWS from "@aws-sdk/client-appconfig";
274
- const client = new AWS.AppConfig({ region: "REGION" });
250
+ import { AppConfig } from "@aws-sdk/client-appconfig";
251
+
252
+ const client = new AppConfig({ region: "REGION" });
275
253
 
276
254
  // async/await.
277
255
  try {
@@ -291,7 +269,7 @@ client
291
269
  // error handling.
292
270
  });
293
271
 
294
- // callbacks.
272
+ // callbacks (not recommended).
295
273
  client.listApplications(params, (err, data) => {
296
274
  // process err and data.
297
275
  });
@@ -319,12 +297,14 @@ try {
319
297
  }
320
298
  ```
321
299
 
300
+ See also [docs/ERROR_HANDLING](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/ERROR_HANDLING.md).
301
+
322
302
  ## Getting Help
323
303
 
324
304
  Please use these community resources for getting help.
325
- We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
305
+ We use GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
326
306
 
327
- - Visit [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)
307
+ - Visit the [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)
328
308
  or [API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/index.html).
329
309
  - Check out the blog posts tagged with [`aws-sdk-js`](https://aws.amazon.com/blogs/developer/tag/aws-sdk-js/)
330
310
  on AWS Developer Blog.
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-appconfig",
3
3
  "description": "AWS SDK for JavaScript Appconfig Client for Node.js, Browser and React Native",
4
- "version": "3.1007.0",
4
+ "version": "3.1009.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:types' 'yarn:build:es' && yarn build:cjs",
7
7
  "build:cjs": "node ../../scripts/compilation/inline client-appconfig",
@@ -21,44 +21,44 @@
21
21
  "dependencies": {
22
22
  "@aws-crypto/sha256-browser": "5.2.0",
23
23
  "@aws-crypto/sha256-js": "5.2.0",
24
- "@aws-sdk/core": "^3.973.19",
25
- "@aws-sdk/credential-provider-node": "^3.972.19",
26
- "@aws-sdk/middleware-host-header": "^3.972.7",
27
- "@aws-sdk/middleware-logger": "^3.972.7",
28
- "@aws-sdk/middleware-recursion-detection": "^3.972.7",
29
- "@aws-sdk/middleware-user-agent": "^3.972.20",
30
- "@aws-sdk/region-config-resolver": "^3.972.7",
31
- "@aws-sdk/types": "^3.973.5",
32
- "@aws-sdk/util-endpoints": "^3.996.4",
33
- "@aws-sdk/util-user-agent-browser": "^3.972.7",
34
- "@aws-sdk/util-user-agent-node": "^3.973.5",
35
- "@smithy/config-resolver": "^4.4.10",
36
- "@smithy/core": "^3.23.9",
37
- "@smithy/fetch-http-handler": "^5.3.13",
38
- "@smithy/hash-node": "^4.2.11",
39
- "@smithy/invalid-dependency": "^4.2.11",
40
- "@smithy/middleware-content-length": "^4.2.11",
41
- "@smithy/middleware-endpoint": "^4.4.23",
42
- "@smithy/middleware-retry": "^4.4.40",
43
- "@smithy/middleware-serde": "^4.2.12",
44
- "@smithy/middleware-stack": "^4.2.11",
45
- "@smithy/node-config-provider": "^4.3.11",
46
- "@smithy/node-http-handler": "^4.4.14",
47
- "@smithy/protocol-http": "^5.3.11",
48
- "@smithy/smithy-client": "^4.12.3",
49
- "@smithy/types": "^4.13.0",
50
- "@smithy/url-parser": "^4.2.11",
24
+ "@aws-sdk/core": "^3.973.20",
25
+ "@aws-sdk/credential-provider-node": "^3.972.21",
26
+ "@aws-sdk/middleware-host-header": "^3.972.8",
27
+ "@aws-sdk/middleware-logger": "^3.972.8",
28
+ "@aws-sdk/middleware-recursion-detection": "^3.972.8",
29
+ "@aws-sdk/middleware-user-agent": "^3.972.21",
30
+ "@aws-sdk/region-config-resolver": "^3.972.8",
31
+ "@aws-sdk/types": "^3.973.6",
32
+ "@aws-sdk/util-endpoints": "^3.996.5",
33
+ "@aws-sdk/util-user-agent-browser": "^3.972.8",
34
+ "@aws-sdk/util-user-agent-node": "^3.973.7",
35
+ "@smithy/config-resolver": "^4.4.11",
36
+ "@smithy/core": "^3.23.11",
37
+ "@smithy/fetch-http-handler": "^5.3.15",
38
+ "@smithy/hash-node": "^4.2.12",
39
+ "@smithy/invalid-dependency": "^4.2.12",
40
+ "@smithy/middleware-content-length": "^4.2.12",
41
+ "@smithy/middleware-endpoint": "^4.4.25",
42
+ "@smithy/middleware-retry": "^4.4.42",
43
+ "@smithy/middleware-serde": "^4.2.14",
44
+ "@smithy/middleware-stack": "^4.2.12",
45
+ "@smithy/node-config-provider": "^4.3.12",
46
+ "@smithy/node-http-handler": "^4.4.16",
47
+ "@smithy/protocol-http": "^5.3.12",
48
+ "@smithy/smithy-client": "^4.12.5",
49
+ "@smithy/types": "^4.13.1",
50
+ "@smithy/url-parser": "^4.2.12",
51
51
  "@smithy/util-base64": "^4.3.2",
52
52
  "@smithy/util-body-length-browser": "^4.2.2",
53
53
  "@smithy/util-body-length-node": "^4.2.3",
54
- "@smithy/util-defaults-mode-browser": "^4.3.39",
55
- "@smithy/util-defaults-mode-node": "^4.2.42",
56
- "@smithy/util-endpoints": "^3.3.2",
57
- "@smithy/util-middleware": "^4.2.11",
58
- "@smithy/util-retry": "^4.2.11",
59
- "@smithy/util-stream": "^4.5.17",
54
+ "@smithy/util-defaults-mode-browser": "^4.3.41",
55
+ "@smithy/util-defaults-mode-node": "^4.2.44",
56
+ "@smithy/util-endpoints": "^3.3.3",
57
+ "@smithy/util-middleware": "^4.2.12",
58
+ "@smithy/util-retry": "^4.2.12",
59
+ "@smithy/util-stream": "^4.5.19",
60
60
  "@smithy/util-utf8": "^4.2.2",
61
- "@smithy/util-waiter": "^4.2.12",
61
+ "@smithy/util-waiter": "^4.2.13",
62
62
  "tslib": "^2.6.2"
63
63
  },
64
64
  "devDependencies": {