The interface for the nbconvert manager.

interface IManager {
    serverSettings: ServerConnection.ISettings;
    exportAs(options: IExportOptions): Promise<void>;
    getExportFormats(force?: boolean): Promise<NbConvert.IExportFormats>;
}

Implemented by

Properties

serverSettings: ServerConnection.ISettings

The server settings used to make API requests.

Methods

  • Export a notebook to a given format.

    Parameters

    • options: IExportOptions

      The export options.

      The interface for the nbconvert export options.

      • OptionalexporterOptions?: { [key: string]: any }

        Additional options for the exporter.

      • format: string

        The export format (e.g., 'html', 'pdf').

      • path: string

        The path to the notebook to export.

    Returns Promise<void>