Skip to content

JSDoc and typescript declaration file (*.d.ts) #163

Open
@WoonchanCho

Description

@WoonchanCho

Hi @pieper and other maintainers,
Thank you so much for initiating and maintaining this great project.
I am trying to test this library out as much as I can in our team's projects and enjoy using it now.

This is not a production issue at all but a kind of improvement suggestion.
As you know, the source code itself is not fully documented.
It would be great to have JsDoc comments at the JavaScript source level.

This will help a lot to users who use a modern editor that provides an IntelliSense with the JsDocs comments.
Even more than that, it will also make creating & maintaining the typescript declaration files (*.d.ts) extremely easy.

I will be happy to add the JsDoc comment to all the active JavaScript sources in the project.
For sure, this will be (should be) no harm to the functionalities of the library because this work will only add comments package.json for the two DevDependencies: JsDoc and TypeScript (Typescript will be used only for creating declaration files)

My only concern is that I'm not a native English speaker, there might be some awkward expression used.
If I add those JsDoc comments, can you review them and update if there is anything weird?

Thank you so much.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions