Elgato_dark/podman-desktop
1
0
Fork 0
mirror of https://github.com/podman-desktop/podman-desktop synced 2026-05-23 09:48:59 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: document command namespace in api (#6353)

Browse source 
* docs: document command namespace in api
Signed-off-by: Philippe Martin <phmartin@redhat.com>

* Update packages/extension-api/src/extension-api.d.ts

Co-authored-by: Florent BENOIT <fbenoit@redhat.com>
Signed-off-by: Philippe Martin <feloy1@gmail.com>

---------

Signed-off-by: Philippe Martin <feloy1@gmail.com>
Co-authored-by: Florent BENOIT <fbenoit@redhat.com>
This commit is contained in:
Philippe Martin 2024-03-11 11:54:45 +01:00 committed by GitHub
parent 6f62bb75a0
commit b2a28dba0b
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 20 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
packages/extension-api/src/extension-api.d.ts vendored
View file

@ -465,8 +465,27 @@ declare module '@podman-desktop/api' {
}
export namespace commands {
/**
* Define a command, to be executed later, either by calling {@link commands.executeCommand} or by referencing its name in the `command` field of a {@link StatusBarItem}.
*
* @param command the name of the command. The name must be unique over all extensions. It is recommended to prefix this name with the name of the extension, to avoid conflicts with commands from other extensions.
* @param callback the command to execute
* @param thisArg The value of `this` provided for the call to callback
* @returns A disposable that unregisters this command when being disposed
* @throws if a command with the same name is already registered.
*/
// eslint-disable-next-line @typescript-eslint/no-explicit-any
export function registerCommand(command: string, callback: (...args: any[]) => any, thisArg?: any): Disposable;
/**
* Execute a command, previously registered with {@link commands.registerCommand}
*
* @param command the name used for registering the command
* @param rest the parameters to pass to the command
* @param T the type of the value returned by the command
* @returns the value returned by the command
* @throws if the command is not registered
* @throws if the command throws an exception
*/
// eslint-disable-next-line @typescript-eslint/no-explicit-any
export function executeCommand<T = unknown>(command: string, ...rest: any[]): PromiseLike<T>;
}
@ -1194,7 +1213,7 @@ declare module '@podman-desktop/api' {
*/
enabled: boolean;
/**
* The identifier of a command to run on click.
* The identifier of a command, previously registered with {@link commands.registerCommand}, to run on click.
*/
command?: string;
/**