fix: include type definitions generated from JSDoc #195
Conversation
wkillerud
commented
Aug 6, 2024
wkillerud
commented
- Update devDependencies and use our shared configs
- Document the API with JSDoc and generate type definitions
- Update the README with examples from JSDoc
Update some devtools to use our shared configs while at it.
|
Windows fails because of eik-lib/common#303 |
| * port: 3000, | ||
| * }); | ||
| * | ||
| * console.log("Listening on http://localhost:3000"); |
There was a problem hiding this comment.
I was curious as to why repeat the readme docs here, as I would think one place would suffice and be easier to keep up to date over time 🤔
There was a problem hiding this comment.
Certainly easier to update, but I think there's value in having the docs both show up in an editor and available on the web. Honestly I'm thinking about adding a third location – the docs on https://eik.dev 😅 (For MetricsJS I ended up moving much of the README.md to be only on the docsite. Maybe we do something like that?)
| } | ||
|
|
||
| /** | ||
| * The pathname to the base on Eik (ex. /pkg/my-app/1.0.0/) |
There was a problem hiding this comment.
"to the base on Eik" does that mean the same as "to the base path in the current sink"?
There was a problem hiding this comment.
No, the base path of the sink would be closer to /. I mean for example /pkg/my-app/1.0.0/.
There was a problem hiding this comment.
riiight, so it's the base path for the current package.
|
🎉 This issue has been resolved in version 1.1.62 🎉 The release is available on: Your semantic-release bot 📦🚀 |
