Skip to content

Commit e8ec1cb

Browse files
chore: Improve documentation
1 parent 79310a5 commit e8ec1cb

File tree

1 file changed

+21
-25
lines changed

1 file changed

+21
-25
lines changed

README.md

Lines changed: 21 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -243,12 +243,12 @@ getLambdas: async (foundLambdas, config) => {
243243
lambda.codePath = lambda.codePath
244244
.replace("/dist/", "/src/")
245245
.replace(".js", ".ts");
246-
}
247-
}
246+
}
247+
}
248248
},
249249
```
250250

251-
**Modfiy esBuild configuration:**
251+
**Modify esBuild configuration:**
252252

253253
```typescript
254254
import { type EsBuildOptions, type LldConfigTs } from "lambda-live-debugger";
@@ -258,12 +258,11 @@ export default {
258258
getLambdas: async (foundLambdas, config) => {
259259
if (foundLambdas) {
260260
for (const lambda of foundLambdas) {
261-
lambda.esBuildOptions = {
262-
target: "node14",
263-
};
264-
}
265-
}
266-
},
261+
lambda.esBuildOptions = {
262+
target: "node14",
263+
};
264+
}
265+
}
267266
} satisfies LldConfigTs;
268267
```
269268
@@ -275,13 +274,13 @@ export default {
275274
...
276275
getLambdas: async (foundLambdas, config) => {
277276
return [
278-
{
279-
// function name as deployed on AWS
280-
functionName: "mystack-myfunction",
281-
codePath: "/src/myLambda.ts",
282-
},
283-
];
284-
},
277+
{
278+
// function name as deployed on AWS
279+
functionName: "mystack-myfunction",
280+
codePath: "/src/myLambda.ts",
281+
},
282+
];
283+
},
285284
} satisfies LldConfigTs;
286285
```
287286
@@ -291,19 +290,16 @@ export default {
291290
import { CdkFramework, type LldConfigBase, type LldConfigTs } from "lambda-live-debugger";
292291

293292
class MyCdkFramework extends CdkFramework {
294-
override getCdkContext(
295-
cdkConfigPath: string,
296-
config: LldConfigBase,
297-
) {
293+
override getCdkContext(cdkConfigPath: string, config: LldConfigBase) {
298294
// your implementation
299-
}
295+
}
300296
}
301297

302298
export default {
303299
...
304-
getLambdas: async (foundLambdas, config) => {
300+
getLambdas: async (foundLambdas, config) => {
305301
return new MyCdkFramework().getLambdas(config);
306-
}
302+
}
307303
} satisfies LldConfigTs;s
308304
```
309305
@@ -328,9 +324,9 @@ Check the [GitHub issues](https://github.com/ServerlessLife/lambda-live-debugger
328324
- [Marko (ServerlessLife)](https://www.serverlesslife.com/)
329325
- ⭐ Your name here for big code contributions
330326
331-
## Contributors (alphabetical)
327+
## Contributors (alphabetical):
332328
333-
- ⭐ Your name here for documentation contributions, minor code additions, or sample projects submitted with bug reports.
329+
- ⭐ Your name here for notable code or documentation contributions, or sample projects submitted with bug reports.
334330
335331
## Declarment
336332

0 commit comments

Comments
 (0)