You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -201,7 +201,7 @@ the generated code change to your PR. Here's how to generate clients:
201
201
There are optional CLI helpers.
202
202
The CLI helpers assist in the dispatch of commands to package or subfolder contexts.
203
203
204
-
To activate the default aliases run:
204
+
To activate the default aliases, run:
205
205
206
206
```
207
207
. ./scripts/cli-dispatcher/set-alias.sh
@@ -260,7 +260,7 @@ matches to: yarn **t**est in packages/**m**iddleware-**sign**ing
260
260
The package name query is used to find the package within clients, lib, or packages, and the npm script query is used to
261
261
find a command to execute from within `package.json``scripts`.
262
262
263
-
In both queries, you can use space-separated substrings. They must occur in the matching package or command in linear order. Priority is given to whole-word matches, initial word matches, and shorter strings. If your instructions are ambiguous the first priority match will be executed. Use the dry-run or confirm options to check your command before execution.
263
+
In both queries, you can use space-separated substrings. They must occur in the matching package or command in linear order. Priority is given to whole-word matches, initial word matches, and shorter strings. If your instructions are ambiguous, the first priority match will be executed. Use the dry-run or confirm options to check your command before execution.
264
264
265
265
Additional options:
266
266
--dry (dry run), --c (confirm before execution), --help
Copy file name to clipboardExpand all lines: README.md
+9-9
Original file line number
Diff line number
Diff line change
@@ -187,7 +187,7 @@ we have them listed in [UPGRADING.md](https://github.com/aws/aws-sdk-js-v3/blob/
187
187
188
188
### General Info
189
189
190
-
The Lambda provided AWS SDK is set to a specific minor version, and **NOT** the latest version. To check the minor version used by Lambda please refer to [Lambda runtimes doc page](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html).
190
+
The Lambda provided AWS SDK is set to a specific minor version, and **NOT** the latest version. To check the minor version used by Lambda, please refer to [Lambda runtimes doc page](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html).
191
191
If you wish to use the latest / different version of the SDK from the one provided by lambda, we recommend that you [bundle and minify](https://aws.amazon.com/blogs/compute/optimizing-node-js-dependencies-in-aws-lambda/) your project, or [upload it as a Lambda layer](https://aws.amazon.com/blogs/compute/using-lambda-layers-to-simplify-your-development-process/).
192
192
193
193
The performance of the AWS SDK for JavaScript v3 on node 18 has improved from v2 as seen in the [performance benchmarking](https://aws.amazon.com/blogs/developer/reduce-lambda-cold-start-times-migrate-to-aws-sdk-for-javascript-v3/)
@@ -344,7 +344,7 @@ The v3 codebase is generated from internal AWS models that AWS services expose.
344
344
345
345
Clients depend on common "utility" code in `/packages`. The code in `/packages` is manually written and outside of special cases (like credentials or abort controller) is generally not very useful alone.
346
346
347
-
Lastly we have higher level libraries in `/lib`. These are javascript specific libraries that wrap client operations to make them easier to work with. Popular examples are `@aws-sdk/lib-dynamodb` which [simplifies working with items in Amazon DynamoDB](https://github.com/aws/aws-sdk-js-v3/blob/main/lib/lib-dynamodb/README.md) or `@aws-sdk/lib-storage` which exposes the `Upload` function and [simplifies parallel uploads in S3's multipartUpload](https://github.com/aws/aws-sdk-js-v3/blob/main/lib/lib-storage/README.md).
347
+
Lastly, we have higher level libraries in `/lib`. These are javascript specific libraries that wrap client operations to make them easier to work with. Popular examples are `@aws-sdk/lib-dynamodb` which [simplifies working with items in Amazon DynamoDB](https://github.com/aws/aws-sdk-js-v3/blob/main/lib/lib-dynamodb/README.md) or `@aws-sdk/lib-storage` which exposes the `Upload` function and [simplifies parallel uploads in S3's multipartUpload](https://github.com/aws/aws-sdk-js-v3/blob/main/lib/lib-storage/README.md).
348
348
349
349
1.`/packages`. This sub directory is where most manual code updates are done. These are published to NPM under `@aws-sdk/XXXX` and have no special prefix.
350
350
1.`/clients`. This sub directory is code generated and depends on code published from `/packages` . It is 1:1 with AWS services and operations. Manual edits should generally not occur here. These are published to NPM under `@aws-sdk/client-XXXX`.
@@ -394,7 +394,7 @@ on a stream.
394
394
395
395
Many AWS operations return paginated results when the response object is too large to return in a single response. In AWS SDK for JavaScript v2, the response contains a token you can use to retrieve the next page of results. You then need to write additional functions to process pages of results.
396
396
397
-
In AWS SDK for JavaScript v3 we’ve improved pagination using async generator functions, which are similar to generator functions, with the following differences:
397
+
In AWS SDK for JavaScript v3, we’ve improved pagination using async generator functions, which are similar to generator functions, with the following differences:
398
398
399
399
- When called, async generator functions return an object, an async generator whose methods (`next`, `throw`, and `return`) return promises for `{ `value`, `done` }`, instead of directly returning `{ `value`, `done` }`. This automatically makes the returned async generator objects async iterators.
400
400
- await expressions and `for await (x of y)` statements are allowed.
@@ -489,7 +489,7 @@ abortController.abort();
489
489
await requestPromise;
490
490
```
491
491
492
-
For a full pagination deep dive please check out our [blog post](https://aws.amazon.com/blogs/developer/pagination-using-async-iterators-in-modular-aws-sdk-for-javascript/).
492
+
For a full pagination deep dive, please check out our [blog post](https://aws.amazon.com/blogs/developer/pagination-using-async-iterators-in-modular-aws-sdk-for-javascript/).
For a full abort controller deep dive please check out our [blog post](https://aws.amazon.com/blogs/developer/abortcontroller-in-modular-aws-sdk-for-javascript/).
526
+
For a full abort controller deep dive, please check out our [blog post](https://aws.amazon.com/blogs/developer/abortcontroller-in-modular-aws-sdk-for-javascript/).
527
527
528
528
### Middleware Stack
529
529
@@ -568,7 +568,7 @@ The example above adds middleware to `build` step of middleware stack. The middl
568
568
- The **build** lifecycle step builds on top of serialized HTTP request. Examples of typical build tasks include injecting HTTP headers that describe a stable aspect of the request, such as `Content-Length` or a body checksum. Any request alterations will be applied to all retries.
569
569
- The **finalizeRequest** lifecycle step prepares the request to be sent over the wire. The request in this stage is semantically complete and should therefore only be altered to match the recipient’s expectations. Examples of typical finalization tasks include request signing, performing retries and injecting hop-by-hop headers.
570
570
- The **deserialize** lifecycle step deserializes the raw response object to a structured response. The upstream middleware have access to deserialized data in next callbacks return value: `result.output`.
571
-
Each middleware must be added to a specific step. By default each middleware in the same step has undifferentiated order. In some cases, you might want to execute a middleware before or after another middleware in the same step. You can achieve it by specifying its `priority`.
571
+
Each middleware must be added to a specific step. By default, each middleware in the same step has undifferentiated order. In some cases, you might want to execute a middleware before or after another middleware in the same step. You can achieve it by specifying its `priority`.
Copy file name to clipboardExpand all lines: UPGRADING.md
+3-3
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@
3
3
This document captures notable changes from AWS SDK for JavaScript v2 to v3.
4
4
The v3 is also known as modular AWS SDK for JavaScript.
5
5
6
-
Because v3 is a modular rewrite of v2, some basic conceptions are different between v2 and v3. You can learn about
6
+
Because, v3 is a modular rewrite of v2, some basic conceptions are different between v2 and v3. You can learn about
7
7
these changes in our [blog posts](https://aws.amazon.com/blogs/developer/category/developer-tools/aws-sdk-for-javascript-in-node-js/).
8
8
The following blog posts will get you up to speed:
9
9
@@ -65,7 +65,7 @@ This list is indexed by [v2 config parameters](https://docs.aws.amazon.com/AWSJa
65
65
httpsAgent:newAgent({
66
66
/*params*/
67
67
}),
68
-
connectionTimeout:/*number in milliseconds*/
68
+
connectionTimeout:/*number in milliseconds*/,
69
69
socketTimeout:/*number in milliseconds*/
70
70
}),
71
71
});
@@ -496,7 +496,7 @@ await ddbDocClient.send(
496
496
497
497
### `undefined` values in when marshalling
498
498
499
-
- In v2 `undefined` values in objects were automatically omitted during the marshalling process to DynamoDB.
499
+
- In v2,`undefined` values in objects were automatically omitted during the marshalling process to DynamoDB.
500
500
501
501
- In v3, the default marshalling behavior in @aws-sdk/lib-dynamodb has changed: objects with `undefined` values are no longer omitted. To align with v2's functionality, developers must explicitly set the `removeUndefinedValues` to `true` in the `marshallOptions` of the DynamoDBDocumentClient.
Copy file name to clipboardExpand all lines: deprecated/packages/middleware-stack/README.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -36,7 +36,7 @@ stack.add(middleware, {
36
36
});
37
37
```
38
38
39
-
This approach works for most cases. Sometimes you want your middleware to be executed in the front of the `Step`, you can set the `Priority` to `high`. Set the `Priority` to `low` then this middleware will be executed at the end of `Step`:
39
+
This approach works for most cases. Sometimes you want your middleware to be executed in the front of the `Step`, you can set the `Priority` to `high`. Set the `Priority` to `low`, then this middleware will be executed at the end of `Step`:
Exports a streamReader function that accepts a readable stream, a function to call on each chunk, and a chunk size in bytes to buffer interally before calling the supplied function.
6
+
Exports a streamReader function that accepts a readable stream, a function to call on each chunk, and a chunk size in bytes to buffer internally before calling the supplied function.
7
7
8
8
This package is meant for the AWS SDK for JavaScript to enable reading a stream with consistent chunk sizes.
0 commit comments