Skip to main content

Function: listInfos()

listInfos(options?): Promise<ContainerEngineInfo[]>

List the engines information.

Parameters

options?: ListInfosOptions

optional options for listing information

Returns

Promise<ContainerEngineInfo[]>

A promise resolving to an array of engine information.

Examples

// Example 1: List all engine information when no specific provider is provided.
const infos = await listInfos();
console.log(infos);
// Example 2: List information for a specific provider.
const provider = provider.getContainerConnections().find(connection => connection.connection.status() === 'started');
const info = await listInfos({ provider: provider.connection });
console.log(info);

Defined in

packages/extension-api/src/extension-api.d.ts:3917