Skip to content

Commit 72485ca

Browse files
committed
chore: prettify README missed in aws#1185
1 parent 5323a81 commit 72485ca

File tree

4 files changed

+15
-19
lines changed

4 files changed

+15
-19
lines changed

README.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -25,10 +25,7 @@ Let’s walk through setting up a project that depends on DynamoDB from the SDK
2525
3. Create a new file called index.js, create a DynamoDB service client and send a request.
2626

2727
```javascript
28-
const {
29-
DynamoDBClient,
30-
ListTablesCommand
31-
} = require("@aws-sdk/client-dynamodb");
28+
const { DynamoDBClient, ListTablesCommand } = require("@aws-sdk/client-dynamodb");
3229

3330
(async () => {
3431
const client = new DynamoDBClient({ region: "us-west-2" });
@@ -109,13 +106,13 @@ Here’s an example of adding a custom header using middleware:
109106
```javascript
110107
const client = new DynamoDB({ region: "us-west-2" });
111108
client.middlewareStack.add(
112-
(next, context) => args => {
109+
(next, context) => (args) => {
113110
args.request.headers["Custom-Header"] = "value";
114111
console.log("\n -- printed from inside middleware -- \n");
115112
return next(args);
116113
},
117114
{
118-
step: "build"
115+
step: "build",
119116
}
120117
);
121118
await client.listTables({});

packages/middleware-stack/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ You can add middleware to specified step with:
2929

3030
```javascript
3131
stack.add(middleware, {
32-
step: "finalizeRequest"
32+
step: "finalizeRequest",
3333
});
3434
```
3535

@@ -38,7 +38,7 @@ This approach works for most cases. Sometimes you want your middleware to be exe
3838
```javascript
3939
stack.add(middleware, {
4040
step: "finalizeRequest",
41-
priority: "high"
41+
priority: "high",
4242
});
4343
```
4444

@@ -51,12 +51,12 @@ In some cases, you might want to execute your middleware before some other known
5151
```javascript
5252
stack.add(middleware, {
5353
step: "finalizeRequest",
54-
name: "myMiddleware"
54+
name: "myMiddleware",
5555
});
5656
stack.addRelativeTo(anotherMiddleware, {
5757
step: "finalizeRequest",
5858
relation: "before", //or 'after'
59-
toMiddleware: "myMiddleware"
59+
toMiddleware: "myMiddleware",
6060
});
6161
```
6262

@@ -92,7 +92,7 @@ If you specify tags for middleware, you can remove multiple middleware at a time
9292
```javascript
9393
stack.add(middleware, {
9494
step: "finalizeRequest",
95-
tags: ["final"]
95+
tags: ["final"],
9696
});
9797
stack.removeByTag("final");
9898
```

packages/s3-request-presigner/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ const nodeSha256 = require("@aws-sdk/hash-node").Hash;
1414
const signer = new S3Presigner({
1515
region: regionProvider,
1616
credentials: credentialsProvider,
17-
sha256: nodeSha256 //if the signer is used in browser, use `browserSha256` then
17+
sha256: nodeSha256, //if the signer is used in browser, use `browserSha256` then
1818
});
1919
const url = await signer.presign(request);
2020
```
@@ -28,7 +28,7 @@ import { Hash as nodeSha256 } from "@aws-sdk/hash-node";
2828
const signer = new S3RequestPresigner({
2929
region: regionProvider,
3030
credentials: credentialsProvider,
31-
sha256: nodeSha256 //if the signer is used in browser, use `browserSha256` then
31+
sha256: nodeSha256, //if the signer is used in browser, use `browserSha256` then
3232
});
3333
const url = await signer.presign(request);
3434
```
@@ -40,6 +40,6 @@ the presigner's constructor.
4040
```javascript
4141
//s3 is instantiated from S3Client from @aws-sdk/client-s3-* packages
4242
const signer = new S3RequestPresigner({
43-
...s3.config
43+
...s3.config,
4444
});
4545
```

packages/util-create-request/README.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -26,14 +26,13 @@ JavaScript usage examples:
2626

2727
```javascript
2828
const S3Client = require("@aws-sdk/client-s3-node/S3Client").S3Client;
29-
const GetObject = require("@aws-sdk/client-s3-node/commands/GetObjectCommand")
30-
.GetObjectCommand;
29+
const GetObject = require("@aws-sdk/client-s3-node/commands/GetObjectCommand").GetObjectCommand;
3130

3231
const request = await createRequest(
3332
new S3Client({}),
3433
new GetObject({
3534
Bucket: "bucket",
36-
Key: "key"
35+
Key: "key",
3736
})
3837
);
3938
/**
@@ -61,7 +60,7 @@ const request = await createRequest<InputTypesUnion, GetObjectInput, Readable>(
6160
new S3Client({}),
6261
new GetObjectCommand({
6362
Bucket: "bucket",
64-
Key: "key"
63+
Key: "key",
6564
})
6665
);
6766
```
@@ -78,7 +77,7 @@ const request = await createRequest(
7877
new DynamoDBClient({}),
7978
new GetObjectCommand({
8079
Bucket: "bucket",
81-
Key: "key"
80+
Key: "key",
8281
})
8382
);
8483
```

0 commit comments

Comments
 (0)