From 63ef3b9c519810e1958eb4596a1ca2e7cc736e97 Mon Sep 17 00:00:00 2001 From: Charles Gagnon Date: Thu, 8 Sep 2022 11:50:05 -0700 Subject: [PATCH] Add doc comments for TreeItem API (#20567) --- src/sql/azdata.d.ts | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/src/sql/azdata.d.ts b/src/sql/azdata.d.ts index 702b2c8020..10c8b5f29a 100644 --- a/src/sql/azdata.d.ts +++ b/src/sql/azdata.d.ts @@ -2775,8 +2775,20 @@ declare module 'azdata' { } 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; + /** + * 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; + /** + * The type of node this is, used as a context key value for the node if set. + */ type?: ExtensionNodeType | undefined; }