@aws-sdk/client-chime 3.1008.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 +33 -33
package/README.md CHANGED
@@ -51,8 +51,9 @@ in the <i>Amazon Web Services General Reference</i>.</p>
51
51
  in the <i>Amazon Chime Administration Guide</i>.</p>
52
52
 
53
53
  ## Installing
54
- To install this package, simply type add or install @aws-sdk/client-chime
55
- using your favorite package manager:
54
+
55
+ To install this package, use the CLI of your favorite package manager:
56
+
56
57
  - `npm install @aws-sdk/client-chime`
57
58
  - `yarn add @aws-sdk/client-chime`
58
59
  - `pnpm add @aws-sdk/client-chime`
@@ -77,15 +78,15 @@ import { ChimeClient, ListAccountsCommand } from "@aws-sdk/client-chime";
77
78
 
78
79
  ### Usage
79
80
 
80
- To send a request, you:
81
+ To send a request:
81
82
 
82
- - Initiate client with configuration (e.g. credentials, region).
83
- - Initiate command with input parameters.
84
- - Call `send` operation on client with command object as input.
85
- - If you are using a custom http handler, you may call `destroy()` to close open connections.
83
+ - Instantiate a client with configuration (e.g. credentials, region).
84
+ - See [docs/CLIENTS](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/CLIENTS.md) for configuration details.
85
+ - See [@aws-sdk/config](https://github.com/aws/aws-sdk-js-v3/blob/main/packages/config/README.md) for additional options.
86
+ - Instantiate a command with input parameters.
87
+ - Call the `send` operation on the client, providing the command object as input.
86
88
 
87
89
  ```js
88
- // a client can be shared by different commands.
89
90
  const client = new ChimeClient({ region: "REGION" });
90
91
 
91
92
  const params = { /** input parameters */ };
@@ -94,7 +95,7 @@ const command = new ListAccountsCommand(params);
94
95
 
95
96
  #### Async/await
96
97
 
97
- We recommend using [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
98
+ We recommend using the [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
98
99
  operator to wait for the promise returned by send operation as follows:
99
100
 
100
101
  ```js
@@ -109,26 +110,9 @@ try {
109
110
  }
110
111
  ```
111
112
 
112
- Async-await is clean, concise, intuitive, easy to debug and has better error handling
113
- as compared to using Promise chains or callbacks.
114
-
115
113
  #### Promises
116
114
 
117
- You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining)
118
- to execute send operation.
119
-
120
- ```js
121
- client.send(command).then(
122
- (data) => {
123
- // process data.
124
- },
125
- (error) => {
126
- // error handling.
127
- }
128
- );
129
- ```
130
-
131
- Promises can also be called using `.catch()` and `.finally()` as follows:
115
+ You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining).
132
116
 
133
117
  ```js
134
118
  client
@@ -144,27 +128,21 @@ client
144
128
  });
145
129
  ```
146
130
 
147
- #### Callbacks
148
-
149
- We do not recommend using callbacks because of [callback hell](http://callbackhell.com/),
150
- but they are supported by the send operation.
131
+ #### Aggregated client
151
132
 
152
- ```js
153
- // callbacks.
154
- client.send(command, (err, data) => {
155
- // process err and data.
156
- });
157
- ```
133
+ The aggregated client class is exported from the same package, but without the "Client" suffix.
158
134
 
159
- #### v2 compatible style
135
+ `Chime` extends `ChimeClient` and additionally supports all operations, waiters, and paginators as methods.
136
+ This style may be familiar to you from the AWS SDK for JavaScript v2.
160
137
 
161
- The client can also send requests using v2 compatible style.
162
- However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post
163
- on [modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/)
138
+ If you are bundling the AWS SDK, we recommend using only the bare-bones client (`ChimeClient`).
139
+ More details are in the blog post on
140
+ [modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/).
164
141
 
165
142
  ```ts
166
- import * as AWS from "@aws-sdk/client-chime";
167
- const client = new AWS.Chime({ region: "REGION" });
143
+ import { Chime } from "@aws-sdk/client-chime";
144
+
145
+ const client = new Chime({ region: "REGION" });
168
146
 
169
147
  // async/await.
170
148
  try {
@@ -184,7 +162,7 @@ client
184
162
  // error handling.
185
163
  });
186
164
 
187
- // callbacks.
165
+ // callbacks (not recommended).
188
166
  client.listAccounts(params, (err, data) => {
189
167
  // process err and data.
190
168
  });
@@ -212,12 +190,14 @@ try {
212
190
  }
213
191
  ```
214
192
 
193
+ See also [docs/ERROR_HANDLING](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/ERROR_HANDLING.md).
194
+
215
195
  ## Getting Help
216
196
 
217
197
  Please use these community resources for getting help.
218
- We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
198
+ We use GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
219
199
 
220
- - Visit [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)
200
+ - Visit the [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)
221
201
  or [API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/index.html).
222
202
  - Check out the blog posts tagged with [`aws-sdk-js`](https://aws.amazon.com/blogs/developer/tag/aws-sdk-js/)
223
203
  on AWS Developer Blog.
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-chime",
3
3
  "description": "AWS SDK for JavaScript Chime Client for Node.js, Browser and React Native",
4
- "version": "3.1008.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-chime",
@@ -21,41 +21,41 @@
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.20",
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.6",
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",
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
59
  "@smithy/util-utf8": "^4.2.2",
60
60
  "tslib": "^2.6.2"
61
61
  },