Interface IOptions

Options for Jupyter plugin registry.

interface IOptions {
    expectedActivationTime?: number;
    validatePlugin?: (plugin: IPlugin<any, any>) => boolean;
}

Hierarchy

  • IOptions
    • IOptions

Properties

expectedActivationTime? validatePlugin?

Properties

OptionalexpectedActivationTime

expectedActivationTime?: number

Time within the plugins are expected to activate.

If a plugin activation time exceed this value, a warning will be logged in the console.

OptionalvalidatePlugin

validatePlugin?: (plugin: IPlugin<any, any>) => boolean

Validate that a plugin is allowed to be registered.

Default is () => true.

Type declaration

    • (plugin: IPlugin<any, any>): boolean

    • Parameters

      • plugin: IPlugin<any, any>

        The plugin to validate

      Returns boolean

      Whether the plugin can be registered or not.

      Notes

      We recommend you print a console message with the reason a plugin is invalid.

Settings

Member Visibility

On This Page

Properties