@aws-sdk/client-codestar-connections 3.1007.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
@@ -88,8 +88,9 @@ Connections.</p>
88
88
  Guide</a>.</p>
89
89
 
90
90
  ## Installing
91
- To install this package, simply type add or install @aws-sdk/client-codestar-connections
92
- using your favorite package manager:
91
+
92
+ To install this package, use the CLI of your favorite package manager:
93
+
93
94
  - `npm install @aws-sdk/client-codestar-connections`
94
95
  - `yarn add @aws-sdk/client-codestar-connections`
95
96
  - `pnpm add @aws-sdk/client-codestar-connections`
@@ -114,15 +115,15 @@ import { CodeStarConnectionsClient, ListHostsCommand } from "@aws-sdk/client-cod
114
115
 
115
116
  ### Usage
116
117
 
117
- To send a request, you:
118
+ To send a request:
118
119
 
119
- - Initiate client with configuration (e.g. credentials, region).
120
- - Initiate command with input parameters.
121
- - Call `send` operation on client with command object as input.
122
- - If you are using a custom http handler, you may call `destroy()` to close open connections.
120
+ - Instantiate a client with configuration (e.g. credentials, region).
121
+ - See [docs/CLIENTS](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/CLIENTS.md) for configuration details.
122
+ - See [@aws-sdk/config](https://github.com/aws/aws-sdk-js-v3/blob/main/packages/config/README.md) for additional options.
123
+ - Instantiate a command with input parameters.
124
+ - Call the `send` operation on the client, providing the command object as input.
123
125
 
124
126
  ```js
125
- // a client can be shared by different commands.
126
127
  const client = new CodeStarConnectionsClient({ region: "REGION" });
127
128
 
128
129
  const params = { /** input parameters */ };
@@ -131,7 +132,7 @@ const command = new ListHostsCommand(params);
131
132
 
132
133
  #### Async/await
133
134
 
134
- We recommend using [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
135
+ We recommend using the [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
135
136
  operator to wait for the promise returned by send operation as follows:
136
137
 
137
138
  ```js
@@ -146,26 +147,9 @@ try {
146
147
  }
147
148
  ```
148
149
 
149
- Async-await is clean, concise, intuitive, easy to debug and has better error handling
150
- as compared to using Promise chains or callbacks.
151
-
152
150
  #### Promises
153
151
 
154
- You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining)
155
- to execute send operation.
156
-
157
- ```js
158
- client.send(command).then(
159
- (data) => {
160
- // process data.
161
- },
162
- (error) => {
163
- // error handling.
164
- }
165
- );
166
- ```
167
-
168
- Promises can also be called using `.catch()` and `.finally()` as follows:
152
+ You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining).
169
153
 
170
154
  ```js
171
155
  client
@@ -181,27 +165,21 @@ client
181
165
  });
182
166
  ```
183
167
 
184
- #### Callbacks
185
-
186
- We do not recommend using callbacks because of [callback hell](http://callbackhell.com/),
187
- but they are supported by the send operation.
168
+ #### Aggregated client
188
169
 
189
- ```js
190
- // callbacks.
191
- client.send(command, (err, data) => {
192
- // process err and data.
193
- });
194
- ```
170
+ The aggregated client class is exported from the same package, but without the "Client" suffix.
195
171
 
196
- #### v2 compatible style
172
+ `CodeStarConnections` extends `CodeStarConnectionsClient` and additionally supports all operations, waiters, and paginators as methods.
173
+ This style may be familiar to you from the AWS SDK for JavaScript v2.
197
174
 
198
- The client can also send requests using v2 compatible style.
199
- However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post
200
- on [modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/)
175
+ If you are bundling the AWS SDK, we recommend using only the bare-bones client (`CodeStarConnectionsClient`).
176
+ More details are in the blog post on
177
+ [modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/).
201
178
 
202
179
  ```ts
203
- import * as AWS from "@aws-sdk/client-codestar-connections";
204
- const client = new AWS.CodeStarConnections({ region: "REGION" });
180
+ import { CodeStarConnections } from "@aws-sdk/client-codestar-connections";
181
+
182
+ const client = new CodeStarConnections({ region: "REGION" });
205
183
 
206
184
  // async/await.
207
185
  try {
@@ -221,7 +199,7 @@ client
221
199
  // error handling.
222
200
  });
223
201
 
224
- // callbacks.
202
+ // callbacks (not recommended).
225
203
  client.listHosts(params, (err, data) => {
226
204
  // process err and data.
227
205
  });
@@ -249,12 +227,14 @@ try {
249
227
  }
250
228
  ```
251
229
 
230
+ See also [docs/ERROR_HANDLING](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/ERROR_HANDLING.md).
231
+
252
232
  ## Getting Help
253
233
 
254
234
  Please use these community resources for getting help.
255
- We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
235
+ We use GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
256
236
 
257
- - Visit [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)
237
+ - Visit the [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)
258
238
  or [API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/index.html).
259
239
  - Check out the blog posts tagged with [`aws-sdk-js`](https://aws.amazon.com/blogs/developer/tag/aws-sdk-js/)
260
240
  on AWS Developer Blog.
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-codestar-connections",
3
3
  "description": "AWS SDK for JavaScript Codestar Connections Client for Node.js, Browser and React Native",
4
- "version": "3.1007.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-codestar-connections",
@@ -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.19",
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.5",
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
  },