Skip to content

Commit 56b23bc

Browse files
committed
chore: update docs
1 parent 4500b4a commit 56b23bc

1 file changed

Lines changed: 21 additions & 2 deletions

File tree

docs/source/index.md

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,11 +71,30 @@ await replane.close()
7171

7272
### Type-safe with Generated Types
7373

74-
Generate TypedDict types from the Replane dashboard for full type safety:
74+
Generate TypedDict types from the Replane dashboard for full type safety.
75+
76+
Example generated `replane_types.py`:
77+
78+
```python
79+
# replane_types.py - Generated from Replane dashboard
80+
from typing import List, TypedDict
81+
82+
class AppSettings(TypedDict):
83+
maxUploadSizeMb: float
84+
allowedFileTypes: List[str]
85+
maintenanceMode: bool
86+
87+
class Configs(TypedDict):
88+
app-settings: AppSettings
89+
rate-limit: int
90+
feature-enabled: bool
91+
```
92+
93+
Usage with generated types:
7594

7695
```python
7796
from replane import Replane
78-
from replane_types import Configs # Generated from dashboard
97+
from replane_types import Configs
7998

8099
with Replane[Configs](
81100
base_url="https://replane.example.com",

0 commit comments

Comments
 (0)