Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation and type is wrong for PluginInstance.getFeed #102

Open
jennydaman opened this issue Feb 15, 2024 · 0 comments
Open

Documentation and type is wrong for PluginInstance.getFeed #102

jennydaman opened this issue Feb 15, 2024 · 0 comments
Labels
bug Something isn't working

Comments

@jennydaman
Copy link
Contributor

/**
* Fetch the feed created by this plugin instance from the REST API
* (only for fs plugins, 'ds' plugins pass null to the resultant Promise).
*
* @param {number} [timeout=30000] - request timeout
*
* @return {Promise<Feed|null>} - JS Promise, resolves to a ``Feed`` object or ``null``
*/
getFeed(timeout = 30000) {

The feed link is available for all plugin instances, not only fs-type plugin instances, so (under normal conditions) the return type should not be a union with null.

@jennydaman jennydaman added the bug Something isn't working label Feb 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

1 participant