Interface IOptions

The options used to create a save handler.

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

Index

Properties

context isConnectedCallback? saveInterval?

Properties

context

context: DocumentRegistry.Context

The context associated with the file.

`Optional` isConnectedCallback

isConnectedCallback?: (() => boolean)

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

Type declaration

- (): boolean
- Returns boolean

`Optional` saveInterval

saveInterval?: number

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