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