The options used to create a save handler.

interface IOptions {
    context: DocumentRegistry.Context;
    isConnectedCallback?: (() => boolean);
    saveInterval?: number;


The context associated with the file.

isConnectedCallback?: (() => boolean)

Autosaving should be paused while this callback function returns false. By default, it always returns true.

Type declaration

    • (): boolean
    • Returns boolean

saveInterval?: number

The minimum save interval in seconds (default is two minutes).