Skip to content

Commit abd64a2

Browse files
authored
docs: update readme with tsconfig example
1 parent ce70347 commit abd64a2

1 file changed

Lines changed: 24 additions & 0 deletions

File tree

README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,30 @@ The CLI requires a specific project structure:
4343
- Event-driven Lambda functions must:
4444
- Use the prefix `EVENT_` (e.g., `EVENT_DataProcessor`)
4545
- Start with a capital letter
46+
47+
### Example tsconfig
48+
49+
```
50+
{
51+
"compilerOptions": {
52+
"target": "es2020",
53+
"experimentalDecorators": true,
54+
"emitDecoratorMetadata": true,
55+
"module": "commonjs",
56+
"moduleResolution": "node",
57+
"baseUrl": "./",
58+
"outDir": "./build",
59+
"esModuleInterop": true,
60+
"forceConsistentCasingInFileNames": true,
61+
"strict": true,
62+
"skipLibCheck": true,
63+
"allowJs": true, // this is to allow custom authorizer
64+
"paths": {
65+
"povery": ["node_modules/povery"]
66+
}
67+
},
68+
}
69+
```
4670

4771
## Installation
4872

0 commit comments

Comments
 (0)