@aws-sdk/client-docdb-elastic 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
@@ -23,8 +23,9 @@ Amazon DocumentDB elastic clusters also simplify how developers interact with Am
23
23
  </ul>
24
24
 
25
25
  ## Installing
26
- To install this package, simply type add or install @aws-sdk/client-docdb-elastic
27
- using your favorite package manager:
26
+
27
+ To install this package, use the CLI of your favorite package manager:
28
+
28
29
  - `npm install @aws-sdk/client-docdb-elastic`
29
30
  - `yarn add @aws-sdk/client-docdb-elastic`
30
31
  - `pnpm add @aws-sdk/client-docdb-elastic`
@@ -49,15 +50,15 @@ import { DocDBElasticClient, ListClustersCommand } from "@aws-sdk/client-docdb-e
49
50
 
50
51
  ### Usage
51
52
 
52
- To send a request, you:
53
+ To send a request:
53
54
 
54
- - Initiate client with configuration (e.g. credentials, region).
55
- - Initiate command with input parameters.
56
- - Call `send` operation on client with command object as input.
57
- - If you are using a custom http handler, you may call `destroy()` to close open connections.
55
+ - Instantiate a client with configuration (e.g. credentials, region).
56
+ - See [docs/CLIENTS](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/CLIENTS.md) for configuration details.
57
+ - See [@aws-sdk/config](https://github.com/aws/aws-sdk-js-v3/blob/main/packages/config/README.md) for additional options.
58
+ - Instantiate a command with input parameters.
59
+ - Call the `send` operation on the client, providing the command object as input.
58
60
 
59
61
  ```js
60
- // a client can be shared by different commands.
61
62
  const client = new DocDBElasticClient({ region: "REGION" });
62
63
 
63
64
  const params = { /** input parameters */ };
@@ -66,7 +67,7 @@ const command = new ListClustersCommand(params);
66
67
 
67
68
  #### Async/await
68
69
 
69
- We recommend using [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
70
+ We recommend using the [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
70
71
  operator to wait for the promise returned by send operation as follows:
71
72
 
72
73
  ```js
@@ -81,26 +82,9 @@ try {
81
82
  }
82
83
  ```
83
84
 
84
- Async-await is clean, concise, intuitive, easy to debug and has better error handling
85
- as compared to using Promise chains or callbacks.
86
-
87
85
  #### Promises
88
86
 
89
- You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining)
90
- to execute send operation.
91
-
92
- ```js
93
- client.send(command).then(
94
- (data) => {
95
- // process data.
96
- },
97
- (error) => {
98
- // error handling.
99
- }
100
- );
101
- ```
102
-
103
- Promises can also be called using `.catch()` and `.finally()` as follows:
87
+ You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining).
104
88
 
105
89
  ```js
106
90
  client
@@ -116,27 +100,21 @@ client
116
100
  });
117
101
  ```
118
102
 
119
- #### Callbacks
120
-
121
- We do not recommend using callbacks because of [callback hell](http://callbackhell.com/),
122
- but they are supported by the send operation.
103
+ #### Aggregated client
123
104
 
124
- ```js
125
- // callbacks.
126
- client.send(command, (err, data) => {
127
- // process err and data.
128
- });
129
- ```
105
+ The aggregated client class is exported from the same package, but without the "Client" suffix.
130
106
 
131
- #### v2 compatible style
107
+ `DocDBElastic` extends `DocDBElasticClient` and additionally supports all operations, waiters, and paginators as methods.
108
+ This style may be familiar to you from the AWS SDK for JavaScript v2.
132
109
 
133
- The client can also send requests using v2 compatible style.
134
- However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post
135
- on [modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/)
110
+ If you are bundling the AWS SDK, we recommend using only the bare-bones client (`DocDBElasticClient`).
111
+ More details are in the blog post on
112
+ [modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/).
136
113
 
137
114
  ```ts
138
- import * as AWS from "@aws-sdk/client-docdb-elastic";
139
- const client = new AWS.DocDBElastic({ region: "REGION" });
115
+ import { DocDBElastic } from "@aws-sdk/client-docdb-elastic";
116
+
117
+ const client = new DocDBElastic({ region: "REGION" });
140
118
 
141
119
  // async/await.
142
120
  try {
@@ -156,7 +134,7 @@ client
156
134
  // error handling.
157
135
  });
158
136
 
159
- // callbacks.
137
+ // callbacks (not recommended).
160
138
  client.listClusters(params, (err, data) => {
161
139
  // process err and data.
162
140
  });
@@ -184,12 +162,14 @@ try {
184
162
  }
185
163
  ```
186
164
 
165
+ See also [docs/ERROR_HANDLING](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/ERROR_HANDLING.md).
166
+
187
167
  ## Getting Help
188
168
 
189
169
  Please use these community resources for getting help.
190
- We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
170
+ We use GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
191
171
 
192
- - Visit [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)
172
+ - Visit the [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)
193
173
  or [API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/index.html).
194
174
  - Check out the blog posts tagged with [`aws-sdk-js`](https://aws.amazon.com/blogs/developer/tag/aws-sdk-js/)
195
175
  on AWS Developer Blog.
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-docdb-elastic",
3
3
  "description": "AWS SDK for JavaScript Docdb Elastic 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-docdb-elastic",
@@ -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.20",
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.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/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
  },