Skip to content

Commit

Permalink
chore: make ts requirement explicit (#707)
Browse files Browse the repository at this point in the history
* chore: make ts requirement explicit

* chore: changeset

* chore: format
  • Loading branch information
tmm authored Jun 13, 2023
1 parent fd76900 commit 3fc045d
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 1 deletion.
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

1 comment on commit 3fc045d

@vercel
Copy link

@vercel vercel bot commented on 3fc045d Jun 13, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.