Skip to content

Commit 65f090b

Browse files
committed
small addition to docs about cli
1 parent 1531d56 commit 65f090b

2 files changed

Lines changed: 9 additions & 0 deletions

File tree

.changeset/spicy-berries-film.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
"next-typesafe-url": patch
3+
---
4+
5+
docs: clarify cli breakpoint and how to fix

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,10 @@ Add `next-typesafe-url` to your dev and build script in package.json.
5959

6060
**Note:** Using the dev script like this causes the `next-typesafe-url` script to run after the `next dev` script, which will hide any output/errors that occur during the build. If you run into issues, you can run `next-typesafe-url` in a separate terminal window to see its output.
6161

62+
### IMPORTANT NOTE
63+
64+
The cli is probably the most likely part to *slightly* break. If you run into issues just run a quick `npx next-typesafe-url` and it should generate the types. If the functions still show type errors, you can restart typescript server, but I have found a quick `crtl+click` to go the origin type file can wake the ts server up much faster.
65+
6266
# Usage
6367

6468
## Route

0 commit comments

Comments
 (0)