Fix some dtslint errors in azdata.d.ts (#8931)

* Fix some dtslint errors in azdata.d.ts

* Undo return type change
This commit is contained in:
Charles Gagnon
2020-01-22 13:04:52 -08:00
committed by GitHub
parent 308dfee963
commit 8b9aeb8679

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

@@ -41,6 +41,19 @@ declare module 'azdata' {
export function registerCapabilitiesServiceProvider(provider: CapabilitiesProvider): vscode.Disposable; export function registerCapabilitiesServiceProvider(provider: CapabilitiesProvider): vscode.Disposable;
/**
* Get the provider corresponding to the given provider ID and type
* @param providerId The ID that the provider was registered with
* @param providerType The type of the provider
*/
export function getProvider<T extends DataProvider>(providerId: string, providerType: DataProviderType): T;
/**
* Get all registered providers of the given type
* @param providerType The type of the providers
*/
export function getProvidersByType<T extends DataProvider>(providerType: DataProviderType): T[];
/** /**
* An [event](#Event) which fires when the specific flavor of a language used in DMP * An [event](#Event) which fires when the specific flavor of a language used in DMP
* connections has changed. And example is for a SQL connection, the flavor changes * connections has changed. And example is for a SQL connection, the flavor changes
@@ -166,7 +179,10 @@ declare module 'azdata' {
* Opens the connection dialog, calls the callback with the result. If connection was successful * Opens the connection dialog, calls the callback with the result. If connection was successful
* returns the connection otherwise returns undefined * returns the connection otherwise returns undefined
*/ */
export function openConnectionDialog(providers?: string[], initialConnectionProfile?: IConnectionProfile, connectionCompletionOptions?: IConnectionCompletionOptions): Thenable<connection.Connection>; export function openConnectionDialog(
providers?: string[],
initialConnectionProfile?: IConnectionProfile,
connectionCompletionOptions?: IConnectionCompletionOptions): Thenable<Connection>;
/** /**
* Opens the connection and add it to object explorer and opens the dashboard and returns the ConnectionResult * Opens the connection and add it to object explorer and opens the dashboard and returns the ConnectionResult
@@ -262,7 +278,6 @@ declare module 'azdata' {
// EXPORTED INTERFACES ///////////////////////////////////////////////// // EXPORTED INTERFACES /////////////////////////////////////////////////
export interface ConnectionInfo { export interface ConnectionInfo {
options: { [name: string]: any }; options: { [name: string]: any };
} }
@@ -353,7 +368,6 @@ declare module 'azdata' {
} }
export interface ConnectionInfoSummary { export interface ConnectionInfoSummary {
/** /**
* URI identifying the owner of the connection * URI identifying the owner of the connection
*/ */
@@ -478,7 +492,6 @@ declare module 'azdata' {
} }
export interface ConnectionProvider extends DataProvider { export interface ConnectionProvider extends DataProvider {
connect(connectionUri: string, connectionInfo: ConnectionInfo): Thenable<boolean>; connect(connectionUri: string, connectionInfo: ConnectionInfo): Thenable<boolean>;
disconnect(connectionUri: string): Thenable<boolean>; disconnect(connectionUri: string): Thenable<boolean>;
@@ -583,7 +596,6 @@ declare module 'azdata' {
fileGroupInfoOptions: ServiceOption[]; fileGroupInfoOptions: ServiceOption[];
} }
// List Databases Request ---------------------------------------------------------------------- // List Databases Request ----------------------------------------------------------------------
export interface ListDatabasesResult { export interface ListDatabasesResult {
databaseNames: Array<string>; databaseNames: Array<string>;
@@ -656,7 +668,6 @@ declare module 'azdata' {
} }
export interface ColumnMetadata { export interface ColumnMetadata {
hasExtendedProperties: boolean; hasExtendedProperties: boolean;
defaultValue: string; defaultValue: string;
@@ -704,9 +715,7 @@ declare module 'azdata' {
} }
export interface TableMetadata { export interface TableMetadata {
columns: ColumnMetadata; columns: ColumnMetadata;
} }
export interface ProviderMetadata { export interface ProviderMetadata {
@@ -746,7 +755,6 @@ declare module 'azdata' {
} }
export interface ScriptingProvider extends DataProvider { export interface ScriptingProvider extends DataProvider {
scriptAsOperation(connectionUri: string, operation: ScriptOperation, metadata: ObjectMetadata, paramDetails: ScriptingParamDetails): Thenable<ScriptingResult>; scriptAsOperation(connectionUri: string, operation: ScriptOperation, metadata: ObjectMetadata, paramDetails: ScriptingParamDetails): Thenable<ScriptingResult>;
registerOnScriptingComplete(handler: (scriptingCompleteResult: ScriptingCompleteResult) => any): void; registerOnScriptingComplete(handler: (scriptingCompleteResult: ScriptingCompleteResult) => any): void;
@@ -961,13 +969,11 @@ declare module 'azdata' {
ownerUri: string; ownerUri: string;
} }
export interface QueryExecuteResultSetNotificationParams { export interface QueryExecuteResultSetNotificationParams {
resultSetSummary: ResultSetSummary; resultSetSummary: ResultSetSummary;
ownerUri: string; ownerUri: string;
} }
export interface QueryExecuteMessageParams { export interface QueryExecuteMessageParams {
message: IResultMessage; message: IResultMessage;
ownerUri: string; ownerUri: string;
@@ -1074,7 +1080,6 @@ declare module 'azdata' {
queryString: string; queryString: string;
} }
export interface EditInitializeResult { } export interface EditInitializeResult { }
// edit/revertCell ---------------------------------------------------------------------------- // edit/revertCell ----------------------------------------------------------------------------
@@ -1796,7 +1801,6 @@ declare module 'azdata' {
// DacFx interfaces ----------------------------------------------------------------------- // DacFx interfaces -----------------------------------------------------------------------
// Security service interfaces ------------------------------------------------------------------------ // Security service interfaces ------------------------------------------------------------------------
export interface CredentialInfo { export interface CredentialInfo {
id: number; id: number;
@@ -2028,7 +2032,6 @@ declare module 'azdata' {
} }
export interface ProfilerSessionStoppedParams { export interface ProfilerSessionStoppedParams {
ownerUri: string; ownerUri: string;
sessionId: number; sessionId: number;
@@ -2404,7 +2407,6 @@ declare module 'azdata' {
} }
export interface DashboardWebview { export interface DashboardWebview {
/** /**
* Raised when the webview posts a message. * Raised when the webview posts a message.
*/ */
@@ -2445,6 +2447,9 @@ declare module 'azdata' {
export function registerWebviewProvider(widgetId: string, handler: (webview: DashboardWebview) => void): void; export function registerWebviewProvider(widgetId: string, handler: (webview: DashboardWebview) => void): void;
} }
/**
* Namespace for interacting with the workspace
*/
export namespace workspace { export namespace workspace {
/** /**
* An event that is emitted when a [dashboard](#DashboardDocument) is opened. * An event that is emitted when a [dashboard](#DashboardDocument) is opened.
@@ -2455,6 +2460,30 @@ declare module 'azdata' {
* An event that is emitted when a [dashboard](#DashboardDocument) is focused. * An event that is emitted when a [dashboard](#DashboardDocument) is focused.
*/ */
export const onDidChangeToDashboard: vscode.Event<DashboardDocument>; export const onDidChangeToDashboard: vscode.Event<DashboardDocument>;
/**
* Create a new model view editor
*/
export function createModelViewEditor(title: string, options?: ModelViewEditorOptions): ModelViewEditor;
export interface ModelViewEditor extends window.ModelViewPanel {
/**
* `true` if there are unpersisted changes.
* This is editable to support extensions updating the dirty status.
*/
isDirty: boolean;
/**
* Opens the editor
*/
openEditor(position?: vscode.ViewColumn): Thenable<void>;
/**
* Registers a save handler for this editor. This will be called if [supportsSave](#ModelViewEditorOptions.supportsSave)
* is set to true and the editor is marked as dirty
*/
registerSaveHandler(handler: () => Thenable<boolean>): void;
}
} }
export interface DashboardDocument { export interface DashboardDocument {
@@ -2474,7 +2503,6 @@ declare module 'azdata' {
} }
export namespace tasks { export namespace tasks {
export interface ITaskHandler { export interface ITaskHandler {
(profile: IConnectionProfile, ...args: any[]): any; (profile: IConnectionProfile, ...args: any[]): any;
} }
@@ -2492,11 +2520,16 @@ declare module 'azdata' {
* @return Disposable which unregisters this task on disposal. * @return Disposable which unregisters this task on disposal.
*/ */
export function registerTask(task: string, callback: ITaskHandler, thisArg?: any): vscode.Disposable; export function registerTask(task: string, callback: ITaskHandler, thisArg?: any): vscode.Disposable;
/**
* Starts an operation to run in the background
* @param operationInfo Operation Information
*/
export function startBackgroundOperation(operationInfo: BackgroundOperationInfo): void;
} }
/** /**
* Supports defining a model that can be instantiated as a view in the UI * Supports defining a model that can be instantiated as a view in the UI
* @export
*/ */
export interface ModelBuilder { export interface ModelBuilder {
navContainer(): ContainerBuilder<NavContainer, any, any>; navContainer(): ContainerBuilder<NavContainer, any, any>;
@@ -2562,16 +2595,13 @@ declare module 'azdata' {
} }
export interface FlexBuilder extends ContainerBuilder<FlexContainer, FlexLayout, FlexItemLayout> { export interface FlexBuilder extends ContainerBuilder<FlexContainer, FlexLayout, FlexItemLayout> {
} }
// Building on top of flex item // Building on top of flex item
export interface SplitViewBuilder extends ContainerBuilder<SplitViewContainer, SplitViewLayout, FlexItemLayout> { export interface SplitViewBuilder extends ContainerBuilder<SplitViewContainer, SplitViewLayout, FlexItemLayout> {
} }
export interface DivBuilder extends ContainerBuilder<DivContainer, DivLayout, DivItemLayout> { export interface DivBuilder extends ContainerBuilder<DivContainer, DivLayout, DivItemLayout> {
} }
export interface GroupBuilder extends ContainerBuilder<GroupContainer, GroupLayout, GroupItemLayout> { export interface GroupBuilder extends ContainerBuilder<GroupContainer, GroupLayout, GroupItemLayout> {
@@ -2766,13 +2796,28 @@ declare module 'azdata' {
} }
export interface NavContainer extends Container<any, any> { export interface NavContainer extends Container<any, any> {
} }
/** /**
* Valid values for the align-items CSS property * Valid values for the align-items CSS property
*/ */
export type AlignItemsType = 'normal' | 'stretch' | 'center' | 'start' | 'end' | 'flex-start' | 'flex-end' | 'baseline' | 'first baseline' | 'last baseline' | 'safe center' | 'unsafe center' | 'inherit' | 'initial' | 'unset'; export type AlignItemsType =
'normal' |
'stretch' |
'center' |
'start' |
'end' |
'flex-start' |
'flex-end' |
'baseline' |
'first baseline' |
'last baseline' |
'safe center' |
'unsafe center' |
'inherit' |
'initial' |
'unset';
/** /**
* Valid values for the justify-content CSS property * Valid values for the justify-content CSS property
*/ */
@@ -2796,7 +2841,31 @@ declare module 'azdata' {
/** /**
* Valid values for the display CSS property * Valid values for the display CSS property
*/ */
export type DisplayType = 'inline' | 'block' | 'contents' | 'flex' | 'grid' | 'inline-block' | 'inline-flex' | 'inline-grid' | 'inline-table' | 'list-item' | 'run-in' | 'table' | 'table-caption' | ' table-column-group' | 'table-header-group' | 'table-footer-group' | 'table-row-group' | 'table-cell' | 'table-column' | 'table-row' | 'none' | 'initial' | 'inherit' | ''; export type DisplayType =
'inline' |
'block' |
'contents' |
'flex' |
'grid' |
'inline-block' |
'inline-flex' |
'inline-grid' |
'inline-table' |
'list-item' |
'run-in' |
'table' |
'table-caption' |
' table-column-group' |
'table-header-group' |
'table-footer-group' |
'table-row-group' |
'table-cell' |
'table-column' |
'table-row' |
'none' |
'initial' |
'inherit' |
'';
/** /**
* The config for a FlexBox-based container. This supports easy * The config for a FlexBox-based container. This supports easy
@@ -2837,7 +2906,7 @@ declare module 'azdata' {
width?: number | string; width?: number | string;
/** /**
* * Matches the text-align CSS property.
*/ */
textAlign?: TextAlignType; textAlign?: TextAlignType;
@@ -2852,7 +2921,6 @@ declare module 'azdata' {
} }
export interface SplitViewLayout extends FlexLayout { export interface SplitViewLayout extends FlexLayout {
/** /**
* Orientation of the views inside split * Orientation of the views inside split
*/ */
@@ -2947,7 +3015,6 @@ declare module 'azdata' {
export interface GroupContainer extends Container<GroupLayout, GroupItemLayout>, GroupContainerProperties { export interface GroupContainer extends Container<GroupLayout, GroupItemLayout>, GroupContainerProperties {
} }
export enum Orientation { export enum Orientation {
Horizontal = 'horizontal', Horizontal = 'horizontal',
Vertical = 'vertial' Vertical = 'vertial'
@@ -3183,7 +3250,6 @@ declare module 'azdata' {
} }
export interface ImageComponentProperties extends ComponentProperties, ComponentWithIcon { export interface ImageComponentProperties extends ComponentProperties, ComponentWithIcon {
} }
export interface GroupContainerProperties { export interface GroupContainerProperties {
@@ -3325,18 +3391,15 @@ declare module 'azdata' {
} }
export interface DomComponent extends Component, DomProperties { export interface DomComponent extends Component, DomProperties {
} }
export interface TextComponent extends Component, TextComponentProperties { export interface TextComponent extends Component, TextComponentProperties {
} }
export interface ImageComponent extends Component, ImageComponentProperties { export interface ImageComponent extends Component, ImageComponentProperties {
} }
export interface HyperlinkComponent extends Component, HyperlinkComponentProperties { export interface HyperlinkComponent extends Component, HyperlinkComponentProperties {
} }
export interface InputBoxComponent extends Component, InputBoxProperties { export interface InputBoxComponent extends Component, InputBoxProperties {
@@ -3443,7 +3506,6 @@ declare module 'azdata' {
* Minimum height for editor component * Minimum height for editor component
*/ */
minimumHeight: number; minimumHeight: number;
} }
export interface DiffEditorComponent extends Component { export interface DiffEditorComponent extends Component {
@@ -3949,7 +4011,7 @@ declare module 'azdata' {
* visualize: ResultSetSummary * visualize: ResultSetSummary
*/ */
export interface QueryEventListener { export interface QueryEventListener {
onQueryEvent(type: QueryEventType, document: queryeditor.QueryDocument, args: ResultSetSummary | string | undefined): void; onQueryEvent(type: QueryEventType, document: QueryDocument, args: ResultSetSummary | string | undefined): void;
} }
// new extensibility interfaces // new extensibility interfaces
@@ -3987,42 +4049,12 @@ declare module 'azdata' {
/** /**
* Register a query event listener * Register a query event listener
*/ */
export function registerQueryEventListener(listener: queryeditor.QueryEventListener): void; export function registerQueryEventListener(listener: QueryEventListener): void;
/** /**
* Get a QueryDocument object for a file URI * Get a QueryDocument object for a file URI
*/ */
export function getQueryDocument(fileUri: string): Thenable<queryeditor.QueryDocument>; export function getQueryDocument(fileUri: string): Thenable<QueryDocument>;
}
/**
* Namespace for interacting with the workspace
*/
export namespace workspace {
/**
* Create a new model view editor
*/
export function createModelViewEditor(title: string, options?: ModelViewEditorOptions): ModelViewEditor;
export interface ModelViewEditor extends window.ModelViewPanel {
/**
* `true` if there are unpersisted changes.
* This is editable to support extensions updating the dirty status.
*/
isDirty: boolean;
/**
* Opens the editor
*/
openEditor(position?: vscode.ViewColumn): Thenable<void>;
/**
* Registers a save handler for this editor. This will be called if [supportsSave](#ModelViewEditorOptions.supportsSave)
* is set to true and the editor is marked as dirty
*/
registerSaveHandler(handler: () => Thenable<boolean>): void;
}
} }
export interface ModelViewEditorOptions { export interface ModelViewEditorOptions {
@@ -4063,22 +4095,6 @@ declare module 'azdata' {
SerializationProvider = 'SerializationProvider' SerializationProvider = 'SerializationProvider'
} }
export namespace dataprotocol {
/**
* Get the provider corresponding to the given provider ID and type
* @param providerId The ID that the provider was registered with
* @param providerType The type of the provider
*/
export function getProvider<T extends DataProvider>(providerId: string, providerType: DataProviderType): T;
/**
* Get all registered providers of the given type
* @param providerType The type of the providers
*/
export function getProvidersByType<T extends DataProvider>(providerType: DataProviderType): T[];
}
/** /**
* Context object passed as an argument to command callbacks. * Context object passed as an argument to command callbacks.
* Defines properties that can be sent for any connected context, * Defines properties that can be sent for any connected context,
@@ -4101,7 +4117,6 @@ declare module 'azdata' {
* explorer tree and take action against it. * explorer tree and take action against it.
*/ */
export interface ObjectExplorerContext extends ConnectedContext { export interface ObjectExplorerContext extends ConnectedContext {
/** /**
* Defines whether this is a Connection-level object. * Defines whether this is a Connection-level object.
* If not, the object is expected to be a child object underneath * If not, the object is expected to be a child object underneath
@@ -4141,7 +4156,6 @@ declare module 'azdata' {
* Operation Information * Operation Information
*/ */
export interface BackgroundOperationInfo { export interface BackgroundOperationInfo {
/** /**
* The operation id. A unique id will be assigned to it If not specified a * The operation id. A unique id will be assigned to it If not specified a
*/ */
@@ -4172,15 +4186,6 @@ declare module 'azdata' {
operation: (operation: BackgroundOperation) => void; operation: (operation: BackgroundOperation) => void;
} }
namespace tasks {
/**
* Starts an operation to run in the background
* @param operationInfo Operation Information
*/
export function startBackgroundOperation(operationInfo: BackgroundOperationInfo): void;
}
export interface ConnectionResult { export interface ConnectionResult {
connected: boolean; connected: boolean;
connectionId: string; connectionId: string;
@@ -4318,7 +4323,6 @@ declare module 'azdata' {
* CellRange objects are __immutable__. * CellRange objects are __immutable__.
*/ */
export class CellRange { export class CellRange {
/** /**
* The start index. It is before or equal to [end](#CellRange.end). * The start index. It is before or equal to [end](#CellRange.end).
*/ */
@@ -4383,7 +4387,8 @@ declare module 'azdata' {
*/ */
clearOutput(cell?: NotebookCell): Thenable<boolean>; clearOutput(cell?: NotebookCell): Thenable<boolean>;
/** Clears the outputs of all code cells in a Notebook /**
* Clears the outputs of all code cells in a Notebook
* @return A promise that resolves with a value indicating if the outputs are cleared or not. * @return A promise that resolves with a value indicating if the outputs are cleared or not.
*/ */
clearAllOutputs(): Thenable<boolean>; clearAllOutputs(): Thenable<boolean>;
@@ -4433,21 +4438,21 @@ declare module 'azdata' {
/** /**
* Default kernel for notebook * Default kernel for notebook
*/ */
defaultKernel?: nb.IKernelSpec; defaultKernel?: IKernelSpec;
/** /**
* Optional content used to give an initial notebook state * Optional content used to give an initial notebook state
*/ */
initialContent?: nb.INotebookContents | string; initialContent?: INotebookContents | string;
/** /**
* A optional boolean value indicating the dirty state after the intial content is loaded, default value is true * A optional boolean value indicating the dirty state after the initial content is loaded, default value is true
*/ */
initialDirtyState?: boolean; initialDirtyState?: boolean;
} }
/** /**
* Represents an event describing the change in a [notebook documents's cells](#NotebookDocument.cells). * Represents an event describing the change in a [notebook document's cells](#NotebookDocument.cells).
*/ */
export interface NotebookCellChangeEvent { export interface NotebookCellChangeEvent {
/** /**
@@ -4455,7 +4460,7 @@ declare module 'azdata' {
*/ */
notebook: NotebookDocument; notebook: NotebookDocument;
/** /**
* The new value for the [notebook documents's cells](#NotebookDocument.cells). * The new value for the [notebook document's cells](#NotebookDocument.cells).
*/ */
cells: NotebookCell[]; cells: NotebookCell[];
/** /**
@@ -4518,7 +4523,6 @@ declare module 'azdata' {
* } * }
* } * }
* ``` * ```
* @export
* @param notebook provider * @param notebook provider
* @returns disposable * @returns disposable
*/ */
@@ -4607,7 +4611,6 @@ declare module 'azdata' {
save(notebookUri: vscode.Uri, notebook: INotebookContents): Thenable<INotebookContents>; save(notebookUri: vscode.Uri, notebook: INotebookContents): Thenable<INotebookContents>;
} }
/** /**
* Interface defining the file format contents of a notebook, usually in a serializable * Interface defining the file format contents of a notebook, usually in a serializable
* format. This interface does not have any methods for manipulating or interacting * format. This interface does not have any methods for manipulating or interacting
@@ -4615,7 +4618,6 @@ declare module 'azdata' {
* *
*/ */
export interface INotebookContents { export interface INotebookContents {
readonly cells: ICellContents[]; readonly cells: ICellContents[];
readonly metadata: INotebookMetadata; readonly metadata: INotebookMetadata;
readonly nbformat: number; readonly nbformat: number;
@@ -4744,7 +4746,7 @@ declare module 'azdata' {
| 'error' | 'error'
| 'update_display_data'; | 'update_display_data';
export type Output = nb.IDisplayData | nb.IUpdateDisplayData | nb.IExecuteResult | nb.IErrorResult | nb.IStreamResult; export type Output = IDisplayData | IUpdateDisplayData | IExecuteResult | IErrorResult | IStreamResult;
//#endregion //#endregion
@@ -4893,7 +4895,6 @@ declare module 'azdata' {
*/ */
requestExecute(content: IExecuteRequest, disposeOnDone?: boolean): IFuture; requestExecute(content: IExecuteRequest, disposeOnDone?: boolean): IFuture;
/** /**
* Send a `complete_request` message. * Send a `complete_request` message.
* *
@@ -5053,7 +5054,6 @@ declare module 'azdata' {
* responses that may come from the kernel. * responses that may come from the kernel.
*/ */
export interface IFuture extends vscode.Disposable { export interface IFuture extends vscode.Disposable {
/** /**
* The original outgoing message. * The original outgoing message.
*/ */
@@ -5232,6 +5232,5 @@ declare module 'azdata' {
} }
//#endregion //#endregion
} }
} }