ckaczor/azuredatastudio
1
0
Fork 0
mirror of https://github.com/ckaczor/azuredatastudio.git synced 2026-02-16 18:46:40 -05:00
Code Issues Packages Projects Releases Wiki Activity

Add doc comments for TreeItem API (#20567)

Browse Source
This commit is contained in:
Charles Gagnon
2022-09-08 11:50:05 -07:00
committed by GitHub
parent 40b2c1e74e
commit 63ef3b9c51
1 changed files with 12 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
src/sql/azdata.d.ts vendored
View File

@@ -2775,8 +2775,20 @@ declare module 'azdata' {
} }
export class TreeItem extends vscode.TreeItem { export class TreeItem extends vscode.TreeItem {
/**
* The connection profile that will be used to create the session with the provider for retrieving children.
* No child nodes will be created if not specified.
*/
payload?: IConnectionProfile | undefined; payload?: IConnectionProfile | undefined;
/**
* Indicates that the children for this node should be retrieved from the specified provider if set, this will retrieve
* all child nodes from the {@link ObjectExplorerProvider}, in addition to any nodes provided by {@link ObjectExplorerNodeProvider}
* with the same provider ID.
*/
childProvider?: string | undefined; childProvider?: string | undefined;
/**
* The type of node this is, used as a context key value for the node if set.
*/
type?: ExtensionNodeType | undefined; type?: ExtensionNodeType | undefined;
} }