Skip to content

Commit e5fa75a

Browse files
committed
refactor: simplify and document config.ts
This PR cleans up the type definition for the configuration object, as well as commenting the hell out of it. There are no duplicate definitions, and I annotated what I could. - `@optional` means providing a value isn't mandatory - `@deprecated` means the field itself isn't necessary _anymore_ in `wrangler.toml` - `@breaking` means the deprecation/optionality is a breaking change from wrangler 1 - `@todo` means there's more work to be done (with details attached) - `@inherited` means the field is copied to all environments I also added a stub for the validation function that will be applied to config objects. In the next PR, I will flesh that function out.
1 parent 18f8f65 commit e5fa75a

File tree

2 files changed

+487
-119
lines changed

2 files changed

+487
-119
lines changed

.changeset/good-rats-shave.md

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
"wrangler": patch
3+
---
4+
5+
refactor: simplify and document `config.ts`
6+
7+
This PR cleans up the type definition for the configuration object, as well as commenting the hell out of it. There are no duplicate definitions, and I annotated what I could.
8+
9+
- `@optional` means providing a value isn't mandatory
10+
- `@deprecated` means the field itself isn't necessary anymore in wrangler.toml
11+
- `@breaking` means the deprecation/optionality is a breaking change from wrangler 1
12+
- `@todo` means there's more work to be done (with details attached)
13+
- `@inherited` means the field is copied to all environments

0 commit comments

Comments
 (0)