Skip to content

Commit 5ca1a8d

Browse files
chore: Improve documentation
1 parent de41ecd commit 5ca1a8d

File tree

1 file changed

+30
-8
lines changed

1 file changed

+30
-8
lines changed

README.md

Lines changed: 30 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ You probably need to tweak some settings. You can do it via CLI parameters or, b
9090
lld -w
9191
```
9292

93-
The configuration is saved to `lldebugger.config.ts`
93+
The configuration is saved to `lldebugger.config.ts`.
9494

9595
### CLI Parameters
9696

@@ -114,6 +114,35 @@ The configuration is saved to `lldebugger.config.ts`
114114
-h, --help display help for command
115115
```
116116

117+
## Configuration file lldebugger.config.ts
118+
119+
Example lldebugger.config.ts:
120+
121+
```typescript
122+
import { type LldConfigTs } from "lambda-live-debugger";
123+
124+
export default {
125+
framework: "cdk",
126+
context: ["environment=development"],
127+
region: "eu-central-1",
128+
observable: false,
129+
verbose: false,
130+
//getLambdas: async (foundLambdas) => {
131+
// you can customize the list of lambdas here or create your own
132+
// return foundLambdas;
133+
//},
134+
} satisfies LldConfigTs;
135+
```
136+
137+
The setting are the same as for CLI parameters.
138+
139+
### Custom framework implementation and adjustment
140+
141+
getLambdas: async (foundLambdas) => {
142+
//you can customize the list of lambdas here or create your own
143+
//return foundLambdas;
144+
},
145+
117146
### Debugging
118147

119148
You might want to configure your development tool for debugging. The wizard automatically configures for VsCode in `.vscode/launch.json`. Here is an example:
@@ -142,13 +171,6 @@ For other tools, please send documentation to include here. WebStorm instruction
142171

143172
Set the `subfolder` parameter if your framework is in a subfolder.
144173

145-
## Custom Configuration
146-
147-
getLambdas: async (foundLambdas) => {
148-
//you can customize the list of lambdas here or create your own
149-
//return foundLambdas;
150-
},
151-
152174
## Removing
153175

154176
To remove Lambda Live Debugger from your AWS account

0 commit comments

Comments
 (0)