@aws-sdk/client-codecommit 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
@@ -394,8 +394,9 @@ by sending data to the trigger target.</p>
394
394
  <p>For information about how to use CodeCommit, see the <a href="https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html">CodeCommit User Guide</a>.</p>
395
395
 
396
396
  ## Installing
397
- To install this package, simply type add or install @aws-sdk/client-codecommit
398
- using your favorite package manager:
397
+
398
+ To install this package, use the CLI of your favorite package manager:
399
+
399
400
  - `npm install @aws-sdk/client-codecommit`
400
401
  - `yarn add @aws-sdk/client-codecommit`
401
402
  - `pnpm add @aws-sdk/client-codecommit`
@@ -420,15 +421,15 @@ import { CodeCommitClient, ListRepositoriesCommand } from "@aws-sdk/client-codec
420
421
 
421
422
  ### Usage
422
423
 
423
- To send a request, you:
424
+ To send a request:
424
425
 
425
- - Initiate client with configuration (e.g. credentials, region).
426
- - Initiate command with input parameters.
427
- - Call `send` operation on client with command object as input.
428
- - If you are using a custom http handler, you may call `destroy()` to close open connections.
426
+ - Instantiate a client with configuration (e.g. credentials, region).
427
+ - See [docs/CLIENTS](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/CLIENTS.md) for configuration details.
428
+ - See [@aws-sdk/config](https://github.com/aws/aws-sdk-js-v3/blob/main/packages/config/README.md) for additional options.
429
+ - Instantiate a command with input parameters.
430
+ - Call the `send` operation on the client, providing the command object as input.
429
431
 
430
432
  ```js
431
- // a client can be shared by different commands.
432
433
  const client = new CodeCommitClient({ region: "REGION" });
433
434
 
434
435
  const params = { /** input parameters */ };
@@ -437,7 +438,7 @@ const command = new ListRepositoriesCommand(params);
437
438
 
438
439
  #### Async/await
439
440
 
440
- We recommend using [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
441
+ We recommend using the [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
441
442
  operator to wait for the promise returned by send operation as follows:
442
443
 
443
444
  ```js
@@ -452,26 +453,9 @@ try {
452
453
  }
453
454
  ```
454
455
 
455
- Async-await is clean, concise, intuitive, easy to debug and has better error handling
456
- as compared to using Promise chains or callbacks.
457
-
458
456
  #### Promises
459
457
 
460
- You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining)
461
- to execute send operation.
462
-
463
- ```js
464
- client.send(command).then(
465
- (data) => {
466
- // process data.
467
- },
468
- (error) => {
469
- // error handling.
470
- }
471
- );
472
- ```
473
-
474
- Promises can also be called using `.catch()` and `.finally()` as follows:
458
+ You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining).
475
459
 
476
460
  ```js
477
461
  client
@@ -487,27 +471,21 @@ client
487
471
  });
488
472
  ```
489
473
 
490
- #### Callbacks
491
-
492
- We do not recommend using callbacks because of [callback hell](http://callbackhell.com/),
493
- but they are supported by the send operation.
474
+ #### Aggregated client
494
475
 
495
- ```js
496
- // callbacks.
497
- client.send(command, (err, data) => {
498
- // process err and data.
499
- });
500
- ```
476
+ The aggregated client class is exported from the same package, but without the "Client" suffix.
501
477
 
502
- #### v2 compatible style
478
+ `CodeCommit` extends `CodeCommitClient` and additionally supports all operations, waiters, and paginators as methods.
479
+ This style may be familiar to you from the AWS SDK for JavaScript v2.
503
480
 
504
- The client can also send requests using v2 compatible style.
505
- However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post
506
- on [modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/)
481
+ If you are bundling the AWS SDK, we recommend using only the bare-bones client (`CodeCommitClient`).
482
+ More details are in the blog post on
483
+ [modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/).
507
484
 
508
485
  ```ts
509
- import * as AWS from "@aws-sdk/client-codecommit";
510
- const client = new AWS.CodeCommit({ region: "REGION" });
486
+ import { CodeCommit } from "@aws-sdk/client-codecommit";
487
+
488
+ const client = new CodeCommit({ region: "REGION" });
511
489
 
512
490
  // async/await.
513
491
  try {
@@ -527,7 +505,7 @@ client
527
505
  // error handling.
528
506
  });
529
507
 
530
- // callbacks.
508
+ // callbacks (not recommended).
531
509
  client.listRepositories(params, (err, data) => {
532
510
  // process err and data.
533
511
  });
@@ -555,12 +533,14 @@ try {
555
533
  }
556
534
  ```
557
535
 
536
+ See also [docs/ERROR_HANDLING](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/ERROR_HANDLING.md).
537
+
558
538
  ## Getting Help
559
539
 
560
540
  Please use these community resources for getting help.
561
- We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
541
+ We use GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
562
542
 
563
- - Visit [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)
543
+ - Visit the [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)
564
544
  or [API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/index.html).
565
545
  - Check out the blog posts tagged with [`aws-sdk-js`](https://aws.amazon.com/blogs/developer/tag/aws-sdk-js/)
566
546
  on AWS Developer Blog.
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-codecommit",
3
3
  "description": "AWS SDK for JavaScript Codecommit 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-codecommit",
@@ -23,41 +23,41 @@
23
23
  "dependencies": {
24
24
  "@aws-crypto/sha256-browser": "5.2.0",
25
25
  "@aws-crypto/sha256-js": "5.2.0",
26
- "@aws-sdk/core": "^3.973.19",
27
- "@aws-sdk/credential-provider-node": "^3.972.20",
28
- "@aws-sdk/middleware-host-header": "^3.972.7",
29
- "@aws-sdk/middleware-logger": "^3.972.7",
30
- "@aws-sdk/middleware-recursion-detection": "^3.972.7",
31
- "@aws-sdk/middleware-user-agent": "^3.972.20",
32
- "@aws-sdk/region-config-resolver": "^3.972.7",
33
- "@aws-sdk/types": "^3.973.5",
34
- "@aws-sdk/util-endpoints": "^3.996.4",
35
- "@aws-sdk/util-user-agent-browser": "^3.972.7",
36
- "@aws-sdk/util-user-agent-node": "^3.973.6",
37
- "@smithy/config-resolver": "^4.4.10",
38
- "@smithy/core": "^3.23.9",
39
- "@smithy/fetch-http-handler": "^5.3.13",
40
- "@smithy/hash-node": "^4.2.11",
41
- "@smithy/invalid-dependency": "^4.2.11",
42
- "@smithy/middleware-content-length": "^4.2.11",
43
- "@smithy/middleware-endpoint": "^4.4.23",
44
- "@smithy/middleware-retry": "^4.4.40",
45
- "@smithy/middleware-serde": "^4.2.12",
46
- "@smithy/middleware-stack": "^4.2.11",
47
- "@smithy/node-config-provider": "^4.3.11",
48
- "@smithy/node-http-handler": "^4.4.14",
49
- "@smithy/protocol-http": "^5.3.11",
50
- "@smithy/smithy-client": "^4.12.3",
51
- "@smithy/types": "^4.13.0",
52
- "@smithy/url-parser": "^4.2.11",
26
+ "@aws-sdk/core": "^3.973.20",
27
+ "@aws-sdk/credential-provider-node": "^3.972.21",
28
+ "@aws-sdk/middleware-host-header": "^3.972.8",
29
+ "@aws-sdk/middleware-logger": "^3.972.8",
30
+ "@aws-sdk/middleware-recursion-detection": "^3.972.8",
31
+ "@aws-sdk/middleware-user-agent": "^3.972.21",
32
+ "@aws-sdk/region-config-resolver": "^3.972.8",
33
+ "@aws-sdk/types": "^3.973.6",
34
+ "@aws-sdk/util-endpoints": "^3.996.5",
35
+ "@aws-sdk/util-user-agent-browser": "^3.972.8",
36
+ "@aws-sdk/util-user-agent-node": "^3.973.7",
37
+ "@smithy/config-resolver": "^4.4.11",
38
+ "@smithy/core": "^3.23.11",
39
+ "@smithy/fetch-http-handler": "^5.3.15",
40
+ "@smithy/hash-node": "^4.2.12",
41
+ "@smithy/invalid-dependency": "^4.2.12",
42
+ "@smithy/middleware-content-length": "^4.2.12",
43
+ "@smithy/middleware-endpoint": "^4.4.25",
44
+ "@smithy/middleware-retry": "^4.4.42",
45
+ "@smithy/middleware-serde": "^4.2.14",
46
+ "@smithy/middleware-stack": "^4.2.12",
47
+ "@smithy/node-config-provider": "^4.3.12",
48
+ "@smithy/node-http-handler": "^4.4.16",
49
+ "@smithy/protocol-http": "^5.3.12",
50
+ "@smithy/smithy-client": "^4.12.5",
51
+ "@smithy/types": "^4.13.1",
52
+ "@smithy/url-parser": "^4.2.12",
53
53
  "@smithy/util-base64": "^4.3.2",
54
54
  "@smithy/util-body-length-browser": "^4.2.2",
55
55
  "@smithy/util-body-length-node": "^4.2.3",
56
- "@smithy/util-defaults-mode-browser": "^4.3.39",
57
- "@smithy/util-defaults-mode-node": "^4.2.42",
58
- "@smithy/util-endpoints": "^3.3.2",
59
- "@smithy/util-middleware": "^4.2.11",
60
- "@smithy/util-retry": "^4.2.11",
56
+ "@smithy/util-defaults-mode-browser": "^4.3.41",
57
+ "@smithy/util-defaults-mode-node": "^4.2.44",
58
+ "@smithy/util-endpoints": "^3.3.3",
59
+ "@smithy/util-middleware": "^4.2.12",
60
+ "@smithy/util-retry": "^4.2.12",
61
61
  "@smithy/util-utf8": "^4.2.2",
62
62
  "tslib": "^2.6.2"
63
63
  },