From f271d1c01520e2804e74a37fd4ad22b867993c00 Mon Sep 17 00:00:00 2001 From: Sandeep Somavarapu Date: Thu, 1 Jun 2017 10:30:02 +0200 Subject: [PATCH] Update vscode.proposed.d.ts --- .../typings/vscode.proposed.d.ts | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/tree-explorer-sample/typings/vscode.proposed.d.ts b/tree-explorer-sample/typings/vscode.proposed.d.ts index 612a3e2b..9c10b66b 100644 --- a/tree-explorer-sample/typings/vscode.proposed.d.ts +++ b/tree-explorer-sample/typings/vscode.proposed.d.ts @@ -14,24 +14,25 @@ declare module 'vscode' { export namespace window { /** - * Register a [TreeDataProvider](#TreeDataProvider) for the registered view `id`. - * @param viewId View id. + * Register a [TreeDataProvider](#TreeDataProvider) for the view contributed using the extension point `views`. + * @param viewId Id of the view contributed using the extension point `views`. * @param treeDataProvider A [TreeDataProvider](#TreeDataProvider) that provides tree data for the view */ export function registerTreeDataProvider(viewId: string, treeDataProvider: TreeDataProvider): Disposable; } /** - * A data provider that provides tree data for a view + * A data provider that provides tree data */ export interface TreeDataProvider { /** * An optional event to signal that an element or root has changed. + * To signal that root has changed, do not pass any argument or pass `undefined` or `null`. */ onDidChangeTreeData?: Event; /** - * get [TreeItem](#TreeItem) representation of the `element` + * Get [TreeItem](#TreeItem) representation of the `element` * * @param element The element for which [TreeItem](#TreeItem) representation is asked for. * @return [TreeItem](#TreeItem) representation of the element @@ -39,12 +40,12 @@ declare module 'vscode' { getTreeItem(element: T): TreeItem | Thenable; /** - * get the children of `element` or root. + * Get the children of `element` or root if no element is passed. * - * @param element The element from which the provider gets children for. - * @return Children of `element` or root. + * @param element The element from which the provider gets children. Can be `undefined`. + * @return Children of `element` or root if no element is passed. */ - getChildren(element?: T): T[] | Thenable; + getChildren(element?: T): ProviderResult; } export class TreeItem {