@jupyterlab/services/lib/kernelspec/kernelspec.d.ts

Client APIs for the Jupyter services REST APIs

import { ISignal } from '@lumino/signaling';
import { IManager as IBaseManager } from '../basemanager';
import { ISpecModel, ISpecModels } from './restapi';
import { ServerConnection } from '..';
export { ISpecModel, ISpecModels };
/**
 * Object which manages kernel instances for a given base url.
 *
 * #### Notes
 * The manager is responsible for maintaining the state of kernel specs.
 */
export interface IManager extends IBaseManager {
    /**
     * A signal emitted when the kernel specs change.
     */
    specsChanged: ISignal<IManager, ISpecModels>;
    /**
     * The kernel spec models.
     *
     * #### Notes
     * The value will be null until the manager is ready.
     */
    readonly specs: ISpecModels | null;
    /**
     * Force a refresh of the specs from the server.
     *
     * @returns A promise that resolves when the specs are fetched.
     *
     * #### Notes
     * This is intended to be called only in response to a user action,
     * since the manager maintains its internal state.
     */
    refreshSpecs(): Promise<void>;
}
/**
 * Interface for making requests to the Kernel Spec API.
 */
export interface IKernelSpecAPIClient {
    /**
     * The server settings for the client.
     */
    readonly serverSettings: ServerConnection.ISettings;
    /**
     * Fetch all of the kernel specs.
     *
     * @returns A promise that resolves with the kernel specs.
     *
     * #### Notes
     * Uses the Jupyter Server API and validates the response model.
     */
    get(): Promise<ISpecModels>;
}