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