@aws-sdk/client-transcribe 3.1008.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 +34 -34
package/README.md CHANGED
@@ -30,8 +30,9 @@ insight into customer service calls, use this option. Refer to for details.</p>
30
30
  </ul>
31
31
 
32
32
  ## Installing
33
- To install this package, simply type add or install @aws-sdk/client-transcribe
34
- using your favorite package manager:
33
+
34
+ To install this package, use the CLI of your favorite package manager:
35
+
35
36
  - `npm install @aws-sdk/client-transcribe`
36
37
  - `yarn add @aws-sdk/client-transcribe`
37
38
  - `pnpm add @aws-sdk/client-transcribe`
@@ -56,15 +57,15 @@ import { TranscribeClient, ListVocabulariesCommand } from "@aws-sdk/client-trans
56
57
 
57
58
  ### Usage
58
59
 
59
- To send a request, you:
60
+ To send a request:
60
61
 
61
- - Initiate client with configuration (e.g. credentials, region).
62
- - Initiate command with input parameters.
63
- - Call `send` operation on client with command object as input.
64
- - If you are using a custom http handler, you may call `destroy()` to close open connections.
62
+ - Instantiate a client with configuration (e.g. credentials, region).
63
+ - See [docs/CLIENTS](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/CLIENTS.md) for configuration details.
64
+ - See [@aws-sdk/config](https://github.com/aws/aws-sdk-js-v3/blob/main/packages/config/README.md) for additional options.
65
+ - Instantiate a command with input parameters.
66
+ - Call the `send` operation on the client, providing the command object as input.
65
67
 
66
68
  ```js
67
- // a client can be shared by different commands.
68
69
  const client = new TranscribeClient({ region: "REGION" });
69
70
 
70
71
  const params = { /** input parameters */ };
@@ -73,7 +74,7 @@ const command = new ListVocabulariesCommand(params);
73
74
 
74
75
  #### Async/await
75
76
 
76
- We recommend using [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
77
+ We recommend using the [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
77
78
  operator to wait for the promise returned by send operation as follows:
78
79
 
79
80
  ```js
@@ -88,26 +89,9 @@ try {
88
89
  }
89
90
  ```
90
91
 
91
- Async-await is clean, concise, intuitive, easy to debug and has better error handling
92
- as compared to using Promise chains or callbacks.
93
-
94
92
  #### Promises
95
93
 
96
- You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining)
97
- to execute send operation.
98
-
99
- ```js
100
- client.send(command).then(
101
- (data) => {
102
- // process data.
103
- },
104
- (error) => {
105
- // error handling.
106
- }
107
- );
108
- ```
109
-
110
- Promises can also be called using `.catch()` and `.finally()` as follows:
94
+ You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining).
111
95
 
112
96
  ```js
113
97
  client
@@ -123,27 +107,21 @@ client
123
107
  });
124
108
  ```
125
109
 
126
- #### Callbacks
127
-
128
- We do not recommend using callbacks because of [callback hell](http://callbackhell.com/),
129
- but they are supported by the send operation.
110
+ #### Aggregated client
130
111
 
131
- ```js
132
- // callbacks.
133
- client.send(command, (err, data) => {
134
- // process err and data.
135
- });
136
- ```
112
+ The aggregated client class is exported from the same package, but without the "Client" suffix.
137
113
 
138
- #### v2 compatible style
114
+ `Transcribe` extends `TranscribeClient` and additionally supports all operations, waiters, and paginators as methods.
115
+ This style may be familiar to you from the AWS SDK for JavaScript v2.
139
116
 
140
- The client can also send requests using v2 compatible style.
141
- However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post
142
- on [modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/)
117
+ If you are bundling the AWS SDK, we recommend using only the bare-bones client (`TranscribeClient`).
118
+ More details are in the blog post on
119
+ [modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/).
143
120
 
144
121
  ```ts
145
- import * as AWS from "@aws-sdk/client-transcribe";
146
- const client = new AWS.Transcribe({ region: "REGION" });
122
+ import { Transcribe } from "@aws-sdk/client-transcribe";
123
+
124
+ const client = new Transcribe({ region: "REGION" });
147
125
 
148
126
  // async/await.
149
127
  try {
@@ -163,7 +141,7 @@ client
163
141
  // error handling.
164
142
  });
165
143
 
166
- // callbacks.
144
+ // callbacks (not recommended).
167
145
  client.listVocabularies(params, (err, data) => {
168
146
  // process err and data.
169
147
  });
@@ -191,12 +169,14 @@ try {
191
169
  }
192
170
  ```
193
171
 
172
+ See also [docs/ERROR_HANDLING](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/ERROR_HANDLING.md).
173
+
194
174
  ## Getting Help
195
175
 
196
176
  Please use these community resources for getting help.
197
- We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
177
+ We use GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
198
178
 
199
- - Visit [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)
179
+ - Visit the [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)
200
180
  or [API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/index.html).
201
181
  - Check out the blog posts tagged with [`aws-sdk-js`](https://aws.amazon.com/blogs/developer/tag/aws-sdk-js/)
202
182
  on AWS Developer Blog.
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-transcribe",
3
3
  "description": "AWS SDK for JavaScript Transcribe Client for Node.js, Browser and React Native",
4
- "version": "3.1008.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-transcribe",
@@ -21,43 +21,43 @@
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
- "@smithy/util-waiter": "^4.2.12",
60
+ "@smithy/util-waiter": "^4.2.13",
61
61
  "tslib": "^2.6.2"
62
62
  },
63
63
  "devDependencies": {