Quick answer
Readonly is the core object here; understand the problem it solves before choosing a tool or workflow. Use readonly/ReadonlyArray to prevent accidental mutation.
Why it matters
Without the concept, format, permission or compatibility issues are easily misread as tool failures.
Still mutable at runtime.
Step by step
- Start with real/complete JSON covering optional fields and empty arrays.
- Check array elements, null/optional and nested objects.
- Set the root name and copy into the project.
- Add Zod/Valibot runtime validation for production.
- Add contract tests/versioning for API changes.
Common mistakes
- Treating a sample as a complete schema, missing optional/empty arrays.
- Trusting generated any/null unions as-is.
- Forgetting quotes for property names with spaces/Chinese.
- Skipping runtime validation after generation.
Checklist
- Sample covers optional/empty arrays/null.
- Array object fields merged.
- Property/root names valid.
- Runtime validation added.
- API contract/version considered.
Key facts
- Still mutable at runtime.
- Freeze for extra safety.
FAQ
What is Readonly?
Readonly is the core object here; understand the problem it solves before choosing a tool or workflow. Use readonly/ReadonlyArray to prevent accidental mutation.
How long does it take?
Usually 1-3 minutes; for intermittent issues, run 30 seconds and retest elsewhere.
Is data uploaded?
Runs locally and does not upload video/audio; extensions may still read the page.
Source: TypeScript readonly