@aws-sdk/client-codecatalyst 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
@@ -183,8 +183,9 @@ and the SSO documentation for your SDK.</p>
183
183
  </note>
184
184
 
185
185
  ## Installing
186
- To install this package, simply type add or install @aws-sdk/client-codecatalyst
187
- using your favorite package manager:
186
+
187
+ To install this package, use the CLI of your favorite package manager:
188
+
188
189
  - `npm install @aws-sdk/client-codecatalyst`
189
190
  - `yarn add @aws-sdk/client-codecatalyst`
190
191
  - `pnpm add @aws-sdk/client-codecatalyst`
@@ -209,15 +210,15 @@ import { CodeCatalystClient, ListSpacesCommand } from "@aws-sdk/client-codecatal
209
210
 
210
211
  ### Usage
211
212
 
212
- To send a request, you:
213
+ To send a request:
213
214
 
214
- - Initiate client with configuration (e.g. credentials, region).
215
- - Initiate command with input parameters.
216
- - Call `send` operation on client with command object as input.
217
- - If you are using a custom http handler, you may call `destroy()` to close open connections.
215
+ - Instantiate a client with configuration (e.g. credentials, region).
216
+ - See [docs/CLIENTS](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/CLIENTS.md) for configuration details.
217
+ - See [@aws-sdk/config](https://github.com/aws/aws-sdk-js-v3/blob/main/packages/config/README.md) for additional options.
218
+ - Instantiate a command with input parameters.
219
+ - Call the `send` operation on the client, providing the command object as input.
218
220
 
219
221
  ```js
220
- // a client can be shared by different commands.
221
222
  const client = new CodeCatalystClient({ region: "REGION" });
222
223
 
223
224
  const params = { /** input parameters */ };
@@ -226,7 +227,7 @@ const command = new ListSpacesCommand(params);
226
227
 
227
228
  #### Async/await
228
229
 
229
- We recommend using [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
230
+ We recommend using the [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
230
231
  operator to wait for the promise returned by send operation as follows:
231
232
 
232
233
  ```js
@@ -241,26 +242,9 @@ try {
241
242
  }
242
243
  ```
243
244
 
244
- Async-await is clean, concise, intuitive, easy to debug and has better error handling
245
- as compared to using Promise chains or callbacks.
246
-
247
245
  #### Promises
248
246
 
249
- You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining)
250
- to execute send operation.
251
-
252
- ```js
253
- client.send(command).then(
254
- (data) => {
255
- // process data.
256
- },
257
- (error) => {
258
- // error handling.
259
- }
260
- );
261
- ```
262
-
263
- Promises can also be called using `.catch()` and `.finally()` as follows:
247
+ You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining).
264
248
 
265
249
  ```js
266
250
  client
@@ -276,27 +260,21 @@ client
276
260
  });
277
261
  ```
278
262
 
279
- #### Callbacks
280
-
281
- We do not recommend using callbacks because of [callback hell](http://callbackhell.com/),
282
- but they are supported by the send operation.
263
+ #### Aggregated client
283
264
 
284
- ```js
285
- // callbacks.
286
- client.send(command, (err, data) => {
287
- // process err and data.
288
- });
289
- ```
265
+ The aggregated client class is exported from the same package, but without the "Client" suffix.
290
266
 
291
- #### v2 compatible style
267
+ `CodeCatalyst` extends `CodeCatalystClient` and additionally supports all operations, waiters, and paginators as methods.
268
+ This style may be familiar to you from the AWS SDK for JavaScript v2.
292
269
 
293
- The client can also send requests using v2 compatible style.
294
- However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post
295
- on [modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/)
270
+ If you are bundling the AWS SDK, we recommend using only the bare-bones client (`CodeCatalystClient`).
271
+ More details are in the blog post on
272
+ [modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/).
296
273
 
297
274
  ```ts
298
- import * as AWS from "@aws-sdk/client-codecatalyst";
299
- const client = new AWS.CodeCatalyst({ region: "REGION" });
275
+ import { CodeCatalyst } from "@aws-sdk/client-codecatalyst";
276
+
277
+ const client = new CodeCatalyst({ region: "REGION" });
300
278
 
301
279
  // async/await.
302
280
  try {
@@ -316,7 +294,7 @@ client
316
294
  // error handling.
317
295
  });
318
296
 
319
- // callbacks.
297
+ // callbacks (not recommended).
320
298
  client.listSpaces(params, (err, data) => {
321
299
  // process err and data.
322
300
  });
@@ -344,12 +322,14 @@ try {
344
322
  }
345
323
  ```
346
324
 
325
+ See also [docs/ERROR_HANDLING](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/ERROR_HANDLING.md).
326
+
347
327
  ## Getting Help
348
328
 
349
329
  Please use these community resources for getting help.
350
- We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
330
+ We use GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
351
331
 
352
- - Visit [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)
332
+ - Visit the [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)
353
333
  or [API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/index.html).
354
334
  - Check out the blog posts tagged with [`aws-sdk-js`](https://aws.amazon.com/blogs/developer/tag/aws-sdk-js/)
355
335
  on AWS Developer Blog.
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-codecatalyst",
3
3
  "description": "AWS SDK for JavaScript Codecatalyst 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-codecatalyst",
@@ -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/middleware-host-header": "^3.972.7",
26
- "@aws-sdk/middleware-logger": "^3.972.7",
27
- "@aws-sdk/middleware-recursion-detection": "^3.972.7",
28
- "@aws-sdk/middleware-user-agent": "^3.972.20",
29
- "@aws-sdk/region-config-resolver": "^3.972.7",
30
- "@aws-sdk/token-providers": "3.1008.0",
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/middleware-host-header": "^3.972.8",
26
+ "@aws-sdk/middleware-logger": "^3.972.8",
27
+ "@aws-sdk/middleware-recursion-detection": "^3.972.8",
28
+ "@aws-sdk/middleware-user-agent": "^3.972.21",
29
+ "@aws-sdk/region-config-resolver": "^3.972.8",
30
+ "@aws-sdk/token-providers": "3.1009.0",
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
  },