@aws-sdk/client-ivschat 3.1008.0 → 3.1010.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
@@ -114,8 +114,9 @@ information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns
114
114
  Reference</i>.</p>
115
115
 
116
116
  ## Installing
117
- To install this package, simply type add or install @aws-sdk/client-ivschat
118
- using your favorite package manager:
117
+
118
+ To install this package, use the CLI of your favorite package manager:
119
+
119
120
  - `npm install @aws-sdk/client-ivschat`
120
121
  - `yarn add @aws-sdk/client-ivschat`
121
122
  - `pnpm add @aws-sdk/client-ivschat`
@@ -140,15 +141,15 @@ import { IvschatClient, ListRoomsCommand } from "@aws-sdk/client-ivschat";
140
141
 
141
142
  ### Usage
142
143
 
143
- To send a request, you:
144
+ To send a request:
144
145
 
145
- - Initiate client with configuration (e.g. credentials, region).
146
- - Initiate command with input parameters.
147
- - Call `send` operation on client with command object as input.
148
- - If you are using a custom http handler, you may call `destroy()` to close open connections.
146
+ - Instantiate a client with configuration (e.g. credentials, region).
147
+ - See [docs/CLIENTS](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/CLIENTS.md) for configuration details.
148
+ - See [@aws-sdk/config](https://github.com/aws/aws-sdk-js-v3/blob/main/packages/config/README.md) for additional options.
149
+ - Instantiate a command with input parameters.
150
+ - Call the `send` operation on the client, providing the command object as input.
149
151
 
150
152
  ```js
151
- // a client can be shared by different commands.
152
153
  const client = new IvschatClient({ region: "REGION" });
153
154
 
154
155
  const params = { /** input parameters */ };
@@ -157,7 +158,7 @@ const command = new ListRoomsCommand(params);
157
158
 
158
159
  #### Async/await
159
160
 
160
- We recommend using [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
161
+ We recommend using the [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
161
162
  operator to wait for the promise returned by send operation as follows:
162
163
 
163
164
  ```js
@@ -172,26 +173,9 @@ try {
172
173
  }
173
174
  ```
174
175
 
175
- Async-await is clean, concise, intuitive, easy to debug and has better error handling
176
- as compared to using Promise chains or callbacks.
177
-
178
176
  #### Promises
179
177
 
180
- You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining)
181
- to execute send operation.
182
-
183
- ```js
184
- client.send(command).then(
185
- (data) => {
186
- // process data.
187
- },
188
- (error) => {
189
- // error handling.
190
- }
191
- );
192
- ```
193
-
194
- Promises can also be called using `.catch()` and `.finally()` as follows:
178
+ You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining).
195
179
 
196
180
  ```js
197
181
  client
@@ -207,27 +191,21 @@ client
207
191
  });
208
192
  ```
209
193
 
210
- #### Callbacks
211
-
212
- We do not recommend using callbacks because of [callback hell](http://callbackhell.com/),
213
- but they are supported by the send operation.
194
+ #### Aggregated client
214
195
 
215
- ```js
216
- // callbacks.
217
- client.send(command, (err, data) => {
218
- // process err and data.
219
- });
220
- ```
196
+ The aggregated client class is exported from the same package, but without the "Client" suffix.
221
197
 
222
- #### v2 compatible style
198
+ `Ivschat` extends `IvschatClient` and additionally supports all operations, waiters, and paginators as methods.
199
+ This style may be familiar to you from the AWS SDK for JavaScript v2.
223
200
 
224
- The client can also send requests using v2 compatible style.
225
- However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post
226
- on [modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/)
201
+ If you are bundling the AWS SDK, we recommend using only the bare-bones client (`IvschatClient`).
202
+ More details are in the blog post on
203
+ [modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/).
227
204
 
228
205
  ```ts
229
- import * as AWS from "@aws-sdk/client-ivschat";
230
- const client = new AWS.Ivschat({ region: "REGION" });
206
+ import { Ivschat } from "@aws-sdk/client-ivschat";
207
+
208
+ const client = new Ivschat({ region: "REGION" });
231
209
 
232
210
  // async/await.
233
211
  try {
@@ -247,7 +225,7 @@ client
247
225
  // error handling.
248
226
  });
249
227
 
250
- // callbacks.
228
+ // callbacks (not recommended).
251
229
  client.listRooms(params, (err, data) => {
252
230
  // process err and data.
253
231
  });
@@ -275,12 +253,14 @@ try {
275
253
  }
276
254
  ```
277
255
 
256
+ See also [docs/ERROR_HANDLING](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/ERROR_HANDLING.md).
257
+
278
258
  ## Getting Help
279
259
 
280
260
  Please use these community resources for getting help.
281
- We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
261
+ We use GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
282
262
 
283
- - Visit [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)
263
+ - Visit the [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)
284
264
  or [API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/index.html).
285
265
  - Check out the blog posts tagged with [`aws-sdk-js`](https://aws.amazon.com/blogs/developer/tag/aws-sdk-js/)
286
266
  on AWS Developer Blog.
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-ivschat",
3
3
  "description": "AWS SDK for JavaScript Ivschat Client for Node.js, Browser and React Native",
4
- "version": "3.1008.0",
4
+ "version": "3.1010.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-ivschat",
@@ -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
  },