NUKnightLab / NUKnightLab/TimelineJS3
Typescript definitions for the client-facing `Timeline` class
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 3.2k
- Forks
- 645
- PR merge metrics
- No merged PRs in 30d
Description
It would be great to have a Typescript type definitions with the JSDoc for the client-facing Timeline class and its arguments.
It will improve the development experience by letting the devs know what properties are available w/o constant consulting with the documentation pages for the data and options. Also, it can prevent silly mistakes and TL source code debug sessions when the passed property has the wrong type or format (this personally happened to me a few times).
The definitions can be published under @types organization with the name @types/timelinejs.
I would like to do the types definitions creation and then I can create a PR for them
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start from the client-facing Timeline class and its arguments, then compare their available properties with the linked data and options documentation. Define the corresponding TypeScript types with JSDoc; done means the class and arguments are covered and the definitions are ready for publication as @types/timelinejs.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, typescript
- Domain
- developer-experience
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100