Class SaveHandler

A class that manages the auto saving of a document.

Notes

Implements https://github.com/ipython/ipython/wiki/IPEP-15:-Autosaving-the-IPython-Notebook.

Implements

IDisposable

Index

Constructors

Properties

_autosaveTimer _context _inDialog _interval _isActive _isConnectedCallback _isDisposed _minInterval _multiplier

Accessors

isActive isDisposed saveInterval

Methods

_save _setTimer dispose start stop

Constructors

constructor

new SaveHandler(options): SaveHandler
Construct a new save handler.
Parameters
- options: SaveHandler.IOptions
Returns SaveHandler
- Defined in packages/docmanager/src/savehandler.ts:18

Properties

`Private` _autosaveTimer

_autosaveTimer: number = -1

`Private` _context

_context: DocumentRegistry.Context

`Private` _inDialog

_inDialog: boolean = false

`Private` _interval

_interval: number = -1

`Private` _isActive

_isActive: boolean = false

`Private` _isConnectedCallback

_isConnectedCallback: (() => boolean)

Type declaration

- (): boolean
- Returns boolean

`Private` _isDisposed

_isDisposed: boolean = false

`Private` _minInterval

_minInterval: number = -1

`Private` _multiplier

_multiplier: number = 10

Accessors

isActive

get isActive(): boolean
Get whether the handler is active.

Returns boolean
- Defined in packages/docmanager/src/savehandler.ts:45

isDisposed

get isDisposed(): boolean
Get whether the save handler is disposed.

Returns boolean
Implementation of IDisposable.isDisposed
- Defined in packages/docmanager/src/savehandler.ts:52

saveInterval

get saveInterval(): number
The save interval used by the timer (in seconds).

Returns number
- Defined in packages/docmanager/src/savehandler.ts:32
set saveInterval(value): void
Parameters
- value: number
Returns void
- Defined in packages/docmanager/src/savehandler.ts:35

Methods

`Private` _save

_save(): void
Handle an autosave timeout.

Returns void
- Defined in packages/docmanager/src/savehandler.ts:104

`Private` _setTimer

_setTimer(): void
Set the timer.

Returns void
- Defined in packages/docmanager/src/savehandler.ts:87

dispose

dispose(): void
Dispose of the resources used by the save handler.

Returns void
Implementation of IDisposable.dispose
- Defined in packages/docmanager/src/savehandler.ts:59

start

start(): void
Start the autosaver.

Returns void
- Defined in packages/docmanager/src/savehandler.ts:71

stop

stop(): void
Stop the autosaver.

Returns void
- Defined in packages/docmanager/src/savehandler.ts:79