@aws-sdk/client-support-app 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
@@ -62,8 +62,9 @@ Reference</i>.</p>
62
62
  </note>
63
63
 
64
64
  ## Installing
65
- To install this package, simply type add or install @aws-sdk/client-support-app
66
- using your favorite package manager:
65
+
66
+ To install this package, use the CLI of your favorite package manager:
67
+
67
68
  - `npm install @aws-sdk/client-support-app`
68
69
  - `yarn add @aws-sdk/client-support-app`
69
70
  - `pnpm add @aws-sdk/client-support-app`
@@ -88,15 +89,15 @@ import { SupportAppClient, ListSlackChannelConfigurationsCommand } from "@aws-sd
88
89
 
89
90
  ### Usage
90
91
 
91
- To send a request, you:
92
+ To send a request:
92
93
 
93
- - Initiate client with configuration (e.g. credentials, region).
94
- - Initiate command with input parameters.
95
- - Call `send` operation on client with command object as input.
96
- - If you are using a custom http handler, you may call `destroy()` to close open connections.
94
+ - Instantiate a client with configuration (e.g. credentials, region).
95
+ - See [docs/CLIENTS](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/CLIENTS.md) for configuration details.
96
+ - See [@aws-sdk/config](https://github.com/aws/aws-sdk-js-v3/blob/main/packages/config/README.md) for additional options.
97
+ - Instantiate a command with input parameters.
98
+ - Call the `send` operation on the client, providing the command object as input.
97
99
 
98
100
  ```js
99
- // a client can be shared by different commands.
100
101
  const client = new SupportAppClient({ region: "REGION" });
101
102
 
102
103
  const params = { /** input parameters */ };
@@ -105,7 +106,7 @@ const command = new ListSlackChannelConfigurationsCommand(params);
105
106
 
106
107
  #### Async/await
107
108
 
108
- We recommend using [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
109
+ We recommend using the [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
109
110
  operator to wait for the promise returned by send operation as follows:
110
111
 
111
112
  ```js
@@ -120,26 +121,9 @@ try {
120
121
  }
121
122
  ```
122
123
 
123
- Async-await is clean, concise, intuitive, easy to debug and has better error handling
124
- as compared to using Promise chains or callbacks.
125
-
126
124
  #### Promises
127
125
 
128
- You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining)
129
- to execute send operation.
130
-
131
- ```js
132
- client.send(command).then(
133
- (data) => {
134
- // process data.
135
- },
136
- (error) => {
137
- // error handling.
138
- }
139
- );
140
- ```
141
-
142
- Promises can also be called using `.catch()` and `.finally()` as follows:
126
+ You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining).
143
127
 
144
128
  ```js
145
129
  client
@@ -155,27 +139,21 @@ client
155
139
  });
156
140
  ```
157
141
 
158
- #### Callbacks
159
-
160
- We do not recommend using callbacks because of [callback hell](http://callbackhell.com/),
161
- but they are supported by the send operation.
142
+ #### Aggregated client
162
143
 
163
- ```js
164
- // callbacks.
165
- client.send(command, (err, data) => {
166
- // process err and data.
167
- });
168
- ```
144
+ The aggregated client class is exported from the same package, but without the "Client" suffix.
169
145
 
170
- #### v2 compatible style
146
+ `SupportApp` extends `SupportAppClient` and additionally supports all operations, waiters, and paginators as methods.
147
+ This style may be familiar to you from the AWS SDK for JavaScript v2.
171
148
 
172
- The client can also send requests using v2 compatible style.
173
- However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post
174
- on [modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/)
149
+ If you are bundling the AWS SDK, we recommend using only the bare-bones client (`SupportAppClient`).
150
+ More details are in the blog post on
151
+ [modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/).
175
152
 
176
153
  ```ts
177
- import * as AWS from "@aws-sdk/client-support-app";
178
- const client = new AWS.SupportApp({ region: "REGION" });
154
+ import { SupportApp } from "@aws-sdk/client-support-app";
155
+
156
+ const client = new SupportApp({ region: "REGION" });
179
157
 
180
158
  // async/await.
181
159
  try {
@@ -195,7 +173,7 @@ client
195
173
  // error handling.
196
174
  });
197
175
 
198
- // callbacks.
176
+ // callbacks (not recommended).
199
177
  client.listSlackChannelConfigurations(params, (err, data) => {
200
178
  // process err and data.
201
179
  });
@@ -223,12 +201,14 @@ try {
223
201
  }
224
202
  ```
225
203
 
204
+ See also [docs/ERROR_HANDLING](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/ERROR_HANDLING.md).
205
+
226
206
  ## Getting Help
227
207
 
228
208
  Please use these community resources for getting help.
229
- We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
209
+ We use GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
230
210
 
231
- - Visit [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)
211
+ - Visit the [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)
232
212
  or [API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/index.html).
233
213
  - Check out the blog posts tagged with [`aws-sdk-js`](https://aws.amazon.com/blogs/developer/tag/aws-sdk-js/)
234
214
  on AWS Developer Blog.
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-support-app",
3
3
  "description": "AWS SDK for JavaScript Support App 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-support-app",
@@ -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
  },