@aws-sdk/client-ecr 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 +34 -34
package/README.md CHANGED
@@ -17,8 +17,9 @@ repositories and images.</p>
17
17
  <i>Amazon Web Services General Reference</i>.</p>
18
18
 
19
19
  ## Installing
20
- To install this package, simply type add or install @aws-sdk/client-ecr
21
- using your favorite package manager:
20
+
21
+ To install this package, use the CLI of your favorite package manager:
22
+
22
23
  - `npm install @aws-sdk/client-ecr`
23
24
  - `yarn add @aws-sdk/client-ecr`
24
25
  - `pnpm add @aws-sdk/client-ecr`
@@ -43,15 +44,15 @@ import { ECRClient, ListImagesCommand } from "@aws-sdk/client-ecr";
43
44
 
44
45
  ### Usage
45
46
 
46
- To send a request, you:
47
+ To send a request:
47
48
 
48
- - Initiate client with configuration (e.g. credentials, region).
49
- - Initiate command with input parameters.
50
- - Call `send` operation on client with command object as input.
51
- - If you are using a custom http handler, you may call `destroy()` to close open connections.
49
+ - Instantiate a client with configuration (e.g. credentials, region).
50
+ - See [docs/CLIENTS](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/CLIENTS.md) for configuration details.
51
+ - See [@aws-sdk/config](https://github.com/aws/aws-sdk-js-v3/blob/main/packages/config/README.md) for additional options.
52
+ - Instantiate a command with input parameters.
53
+ - Call the `send` operation on the client, providing the command object as input.
52
54
 
53
55
  ```js
54
- // a client can be shared by different commands.
55
56
  const client = new ECRClient({ region: "REGION" });
56
57
 
57
58
  const params = { /** input parameters */ };
@@ -60,7 +61,7 @@ const command = new ListImagesCommand(params);
60
61
 
61
62
  #### Async/await
62
63
 
63
- We recommend using [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
64
+ We recommend using the [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
64
65
  operator to wait for the promise returned by send operation as follows:
65
66
 
66
67
  ```js
@@ -75,26 +76,9 @@ try {
75
76
  }
76
77
  ```
77
78
 
78
- Async-await is clean, concise, intuitive, easy to debug and has better error handling
79
- as compared to using Promise chains or callbacks.
80
-
81
79
  #### Promises
82
80
 
83
- You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining)
84
- to execute send operation.
85
-
86
- ```js
87
- client.send(command).then(
88
- (data) => {
89
- // process data.
90
- },
91
- (error) => {
92
- // error handling.
93
- }
94
- );
95
- ```
96
-
97
- Promises can also be called using `.catch()` and `.finally()` as follows:
81
+ You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining).
98
82
 
99
83
  ```js
100
84
  client
@@ -110,27 +94,21 @@ client
110
94
  });
111
95
  ```
112
96
 
113
- #### Callbacks
114
-
115
- We do not recommend using callbacks because of [callback hell](http://callbackhell.com/),
116
- but they are supported by the send operation.
97
+ #### Aggregated client
117
98
 
118
- ```js
119
- // callbacks.
120
- client.send(command, (err, data) => {
121
- // process err and data.
122
- });
123
- ```
99
+ The aggregated client class is exported from the same package, but without the "Client" suffix.
124
100
 
125
- #### v2 compatible style
101
+ `ECR` extends `ECRClient` and additionally supports all operations, waiters, and paginators as methods.
102
+ This style may be familiar to you from the AWS SDK for JavaScript v2.
126
103
 
127
- The client can also send requests using v2 compatible style.
128
- However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post
129
- on [modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/)
104
+ If you are bundling the AWS SDK, we recommend using only the bare-bones client (`ECRClient`).
105
+ More details are in the blog post on
106
+ [modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/).
130
107
 
131
108
  ```ts
132
- import * as AWS from "@aws-sdk/client-ecr";
133
- const client = new AWS.ECR({ region: "REGION" });
109
+ import { ECR } from "@aws-sdk/client-ecr";
110
+
111
+ const client = new ECR({ region: "REGION" });
134
112
 
135
113
  // async/await.
136
114
  try {
@@ -150,7 +128,7 @@ client
150
128
  // error handling.
151
129
  });
152
130
 
153
- // callbacks.
131
+ // callbacks (not recommended).
154
132
  client.listImages(params, (err, data) => {
155
133
  // process err and data.
156
134
  });
@@ -178,12 +156,14 @@ try {
178
156
  }
179
157
  ```
180
158
 
159
+ See also [docs/ERROR_HANDLING](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/ERROR_HANDLING.md).
160
+
181
161
  ## Getting Help
182
162
 
183
163
  Please use these community resources for getting help.
184
- We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
164
+ We use GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
185
165
 
186
- - Visit [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)
166
+ - Visit the [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)
187
167
  or [API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/index.html).
188
168
  - Check out the blog posts tagged with [`aws-sdk-js`](https://aws.amazon.com/blogs/developer/tag/aws-sdk-js/)
189
169
  on AWS Developer Blog.
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-ecr",
3
3
  "description": "AWS SDK for JavaScript Ecr 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-ecr",
@@ -23,43 +23,43 @@
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
- "@smithy/util-waiter": "^4.2.12",
62
+ "@smithy/util-waiter": "^4.2.13",
63
63
  "tslib": "^2.6.2"
64
64
  },
65
65
  "devDependencies": {