I added jsdoc comments for the added benefit of autocompletion. Doc strings are a combination of what is already in the readme, a bit of the Facebook docs, and some editorialised explanations of the private functions.
I personally prefer this method over what has been done in PR #114 as inline documentation is much more helpful, although #114 could benefit TypeScript users (I'm not a TS user so wouldn't want to comment).
Charca
commented
6 years ago
I added jsdoc comments for the added benefit of autocompletion. Doc strings are a combination of what is already in the readme, a bit of the Facebook docs, and some editorialised explanations of the private functions.
I personally prefer this method over what has been done in PR #114 as inline documentation is much more helpful, although #114 could benefit TypeScript users (I'm not a TS user so wouldn't want to comment).
Closes #115