Interface

AutosaveConfig (autosave)

@ckeditor/ckeditor5-autosave/src/autosave

interface

The configuration of the autosave feature.

ClassicEditor
	.create( editorElement, {
		autosave: {
			save( editor: Editor ) {
				// The saveData() function must return a promise
				// which should be resolved when the data is successfully saved.
				return saveData( editor.getData() );
			}
		}
	} );
	.then( ... )
	.catch( ... );

See all editor configuration options.

See also the demo of the autosave feature.

Filtering

Properties

  • save : ( Editor ) => Promise<unknown> | undefined

    The callback to be executed when the data needs to be saved.

    This function must return a promise which should be resolved when the data is successfully saved.

    ClassicEditor
    	.create( editorElement, {
    		autosave: {
    			save( editor: Editor ) {
    				return saveData( editor.getData() );
    			}
    		}
    	} );
    	.then( ... )
    	.catch( ... );
    
  • waitingTime : number | undefined

    The minimum amount of time that needs to pass after the last action to call the provided callback. By default it is 1000 ms.

    ClassicEditor
    	.create( editorElement, {
    		autosave: {
    			save( editor: Editor ) {
    				return saveData( editor.getData() );
    			},
    			waitingTime: 2000
    		}
    	} );
    	.then( ... )
    	.catch( ... );