Skip to content

Commit 881009d

Browse files
committed
add jsdoc
1 parent 1b212bd commit 881009d

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

src/platform/notebooks/deepnote/types.ts

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,23 @@ export interface IIntegrationStorage extends IDisposable {
1111
readonly onDidChangeIntegrations: Event<void>;
1212

1313
getAll(): Promise<IntegrationConfig[]>;
14+
15+
/**
16+
* Retrieves the global (non-project-scoped) integration configuration by integration ID.
17+
*
18+
* This method returns integration configurations that are stored globally and shared
19+
* across all projects. These configurations are stored in VSCode's SecretStorage and
20+
* are scoped to the user's machine.
21+
*
22+
* This differs from `getProjectIntegrationConfig()` which returns project-scoped
23+
* configurations that are specific to a particular Deepnote project and stored
24+
* within the project's YAML file.
25+
*
26+
* @param integrationId - The unique identifier of the integration to retrieve
27+
* @returns A Promise that resolves to:
28+
* - The `IntegrationConfig` object if a global configuration exists for the given ID
29+
* - `undefined` if no global configuration exists for the given integration ID
30+
*/
1431
getIntegrationConfig(integrationId: string): Promise<IntegrationConfig | undefined>;
1532

1633
/**

0 commit comments

Comments
 (0)