-
Notifications
You must be signed in to change notification settings - Fork 93
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
Add return types to all interface methods in Zowe Explorer API #2952
Comments
Thank you for raising this enhancement request. |
Something to consider as part of adding return types: do we intend on supporting asynchronous types for some functions? For example, the /**
* Rename the node. Begins a dialog.
* @param the node to be renamed
*/
rename(node: IZoweTreeNode): void | PromiseLike<void>; |
Signed-off-by: zFernand0 <[email protected]>
Signed-off-by: zFernand0 <[email protected]>
Signed-off-by: zFernand0 <[email protected]>
Signed-off-by: zFernand0 <[email protected]>
Signed-off-by: zFernand0 <[email protected]>
types: Add missing return types, see #2952
Zowe Explorer API defines many interfaces containing methods, some of which do not have return types defined.
For example, many of the methods on the
IZoweTree
interface are lacking return types:https://github.com/zowe/zowe-explorer-vscode/blob/next/packages/zowe-explorer-api/src/tree/IZoweTree.ts
Adding return types could be considered a breaking change but should improve the experience for developers/extenders. For example, when calling
ZoweTreeProvider.addFavorite
it'd be nice to have a return typePromise<void>
displayed by IntelliSense instead ofany
😋The text was updated successfully, but these errors were encountered: