Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: make ts requirement explicit #707

Merged
merged 3 commits into from
Jun 13, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/cool-icons-relax.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"viem": patch
---

Made TypeScript requirement explicit (was missing previously).
8 changes: 8 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -138,6 +138,14 @@
]
}
},
"peerDependencies": {
"typescript": ">=5.0.4"
},
"peerDependenciesMeta": {
"typescript": {
"optional": true
}
},
"dependencies": {
"@adraffy/ens-normalize": "1.9.0",
"@noble/curves": "1.0.0",
Expand Down
2 changes: 1 addition & 1 deletion site/docs/typescript.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ head:

viem is designed to be as type-safe as possible! Things to keep in mind:

- Types currently require using TypeScript v4.9.4 or greater.
- Types currently require using TypeScript v5.0.4 or greater.
- Changes to types in this repository are considered non-breaking and are usually released as patch semver changes (otherwise every type enhancement would be a major version!).
- It is highly recommended that you lock your `viem` package version to a specific patch release and upgrade with the expectation that types may be fixed or upgraded between any release.
- The non-type-related public API of `viem` still follows semver very strictly.
Expand Down