automatic API documentation generation in the future
The annotations should be based on the current API section of a readme, but a bit more detailed. Examples should be included (can be copied straight from the README). Good English is important - I'm not a native speaker so I would be very happy if someone from an English-speaking country could write these. But if you aren't native either, your contribution is still very welcome.
Why?
The annotations should be based on the current API section of a readme, but a bit more detailed. Examples should be included (can be copied straight from the README). Good English is important - I'm not a native speaker so I would be very happy if someone from an English-speaking country could write these. But if you aren't native either, your contribution is still very welcome.
Reference: https://www.typescriptlang.org/docs/handbook/jsdoc-supported-types.html