Skip to content

Commit

Permalink
Add API signature info to @intersystems-community/intersystems-server…
Browse files Browse the repository at this point in the history
…manager
  • Loading branch information
gjsjohnmurray committed Nov 12, 2024
1 parent d3dc80f commit b62ed04
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 0 deletions.
4 changes: 4 additions & 0 deletions types/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@ Package defining the interfaces used in the API that is published by the `inters

# Changelog

### v3.8.0

- Add function signatures, including `getAccount` which was introduced in Server Manager 3.8.0.

### v3.4.1

- Add optional `superServer` object.
Expand Down
33 changes: 33 additions & 0 deletions types/index.d.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
import * as vscode from 'vscode';

export const EXTENSION_ID: string;
export const AUTHENTICATION_PROVIDER: string;

Expand Down Expand Up @@ -30,3 +32,34 @@ export interface IJSONServerSpec {
export interface IServerSpec extends IJSONServerSpec {
name: string;
}

export interface ServerManagerAPI {
pickServer(
scope?: vscode.ConfigurationScope,
options?: vscode.QuickPickOptions,
): Promise<string | undefined>;

getServerNames(
scope?: vscode.ConfigurationScope,
sorted?: boolean,
): IServerName[];

getServerSummary(
name: string,
scope?: vscode.ConfigurationScope,
): IServerName | undefined;

getServerSpec(
name: string,
scope?: vscode.ConfigurationScope,
flushCredentialCache?: boolean,
options?: { hideFromRecents?: boolean, /* Obsolete */ noCredentials?: boolean },
): Promise<IServerSpec | undefined>;

getAccount(
serverSpec: IServerSpec
): vscode.AuthenticationSessionAccountInformation | undefined;

onDidChangePassword(
): vscode.Event<string>;
}

0 comments on commit b62ed04

Please sign in to comment.