# Autosave

class

The [`Autosave`](module_autosave_autosave-Autosave.md) plugin allows you to automatically save the data (e.g. send it to the server) when needed (when the user changed the content).

It listens to the [`editor.model.document#change:data`](module_engine_model_document-ModelDocument.md#event-change:data) and `window#beforeunload` events and calls the [`config.autosave.save()`](module_autosave_autosave-AutosaveAdapter.md#function-save) function.

```typescript
ClassicEditor
	.create( {
		attachTo: document.querySelector( '#editor' ),
		plugins: [ ArticlePluginSet, Autosave ],
		toolbar: [ 'heading', '|', 'bold', 'italic', 'link', 'bulletedList', 'numberedList', 'blockQuote', 'undo', 'redo' ],
		image: {
			toolbar: [ 'imageStyle:block', 'imageStyle:side', '|', 'toggleImageCaption', 'imageTextAlternative' ],
		},
		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() );
			}
		}
	} );
```

Read more about this feature in the [Autosave](../features/autosave.md) feature guide.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-autosave/src/autosave.ts#L55)

<a id="properties">

## Properties

<a id="member-_saveCallbacks">

### `_saveCallbacks: Array<( editor: Editor ) => Promise<unknown>>` _(readonly)_

Saves callbacks.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-autosave/src/autosave.ts#L338)

<a id="member-adapter">

### `adapter?: AutosaveAdapter`

The adapter is an object with a `save()` method. That method will be called whenever the data changes. It might be called some time after the change, since the event is throttled for performance reasons.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-autosave/src/autosave.ts#L62)

<a id="member-editor">

### `editor: Editor` _(readonly)_

The editor instance.

Note that most editors implement the [`ui`](module_core_editor_editor-Editor.md#member-ui) property. However, editors with an external UI (i.e. Bootstrap-based) or a headless editor may not have this property or throw an error when accessing it.

Because of above, to make plugins more universal, it is recommended to split features into:

* The "editing" part that uses the [`Editor`](module_core_editor_editor-Editor.md) class without `ui` property.
* The "UI" part that uses the [`Editor`](module_core_editor_editor-Editor.md) class and accesses `ui` property.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-core/src/plugin.ts#L33)

<a id="member-isEnabled">

### `isEnabled: boolean` _(readonly)_

Flag indicating whether a plugin is enabled or disabled. A disabled plugin will not transform text.

Plugin can be simply disabled like that:

```typescript
// Disable the plugin so that no toolbars are visible.
editor.plugins.get( 'TextTransformation' ).isEnabled = false;
```

You can also use [`forceDisabled`](#function-forceDisabled) method.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-core/src/plugin.ts#L51)

<a id="member-state">

### `state: 'error' | 'waiting' | 'synchronized' | 'saving'` _(readonly)_

The state of this plugin.

The plugin can be in the following states:

* synchronized – When all changes are saved.
* waiting – When the plugin is waiting for other changes before calling `adapter#save()` and `config.autosave.save()`.
* saving – When the provided save method is called and the plugin waits for the response.
* error \&ndash When the provided save method will throw an error. This state immediately changes to the `saving` state and the save method will be called again in the short period of time.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-autosave/src/autosave.ts#L78)

<a id="member-_action">

### `_action: PendingAction | null` _(private)_

An action that will be added to the pending action manager for actions happening in that plugin.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-autosave/src/autosave.ts#L125)

<a id="member-_config">

### `_config: AutosaveConfig` _(private)_

The configuration of this plugins.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-autosave/src/autosave.ts#L107)

<a id="member-_debouncedSave">

### `_debouncedSave: DebouncedFunc<() => void>` _(private)_

Debounced save method. The `save()` method is called the specified `waitingTime` after `debouncedSave()` is called, unless a new action happens in the meantime.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-autosave/src/autosave.ts#L84)

<a id="member-_domEmitter">

### `_domEmitter: DomEmitter` _(private)_

DOM emitter.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-autosave/src/autosave.ts#L102)

<a id="member-_lastDocumentVersion">

### `_lastDocumentVersion: number` _(private)_

The last saved document version.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-autosave/src/autosave.ts#L89)

<a id="member-_makeImmediateSave">

### `_makeImmediateSave: boolean` _(private)_

Informs whether there should be another autosave callback performed, immediately after current autosave callback finishes.

This is set to `true` when there is a save request while autosave callback is already being processed and the model has changed since the last save.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-autosave/src/autosave.ts#L120)

<a id="member-_pendingActions">

### `_pendingActions: PendingActions` _(private)_

Editor's pending actions manager.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-autosave/src/autosave.ts#L112)

<a id="member-_savePromise">

### `_savePromise: Promise<void> | null` _(private)_

Promise used for asynchronous save calls.

Created to handle the autosave call to an external data source. It resolves when that call is finished. It is re-used if save is called before the promise has been resolved. It is set to `null` if there is no call in progress.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-autosave/src/autosave.ts#L97)

#### Static properties

<a id="static-member-isContextPlugin">

### `isContextPlugin: false` _(readonly)_

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-core/src/plugin.ts#L144)

<a id="static-member-pluginName">

### `pluginName: 'Autosave'` _(readonly)_

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-autosave/src/autosave.ts#L130)

<a id="static-member-requires">

### `requires: readonly [ PluginConstructor<Editor> & new ( context: Editor ) => PendingActions ]` _(readonly)_

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-autosave/src/autosave.ts#L144)

<a id="static-member-isOfficialPlugin">

### `isOfficialPlugin: true` _(internal)_

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-autosave/src/autosave.ts#L137)

<a id="static-member-isPremiumPlugin">

### `isPremiumPlugin: boolean` _(internal)_

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-core/src/plugin.ts#L160)

<a id="methods">

## Methods

<a id="function-constructor">

### `constructor( editor )`

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-autosave/src/autosave.ts#L151)

#### Parameters

* `editor: Editor`

<a id="function-bind:DUAL_BIND">

### `bind( bindProperty1, bindProperty2 ) → ObservableDualBindChain<K1, Autosave[ K1 ], K2, Autosave[ K2 ]>` _(inherited)_

Binds [observable properties](#function-set:KEY_VALUE) to other objects implementing the [`Observable`](module_utils_observablemixin-Observable.md) interface.

Read more in the [dedicated](../framework/deep-dive/observables.md#property-bindings) guide covering the topic of property bindings with some additional examples.

Consider two objects: a `button` and an associated `command` (both `Observable`).

A simple property binding could be as follows:

```typescript
button.bind( 'isEnabled' ).to( command, 'isEnabled' );
```

or even shorter:

```typescript
button.bind( 'isEnabled' ).to( command );
```

which works in the following way:

* `button.isEnabled` **instantly equals** `command.isEnabled`,
* whenever `command.isEnabled` changes, `button.isEnabled` will immediately reflect its value.

**Note**: To release the binding, use [`unbind`](module_utils_observablemixin-Observable.md#function-unbind).

You can also "rename" the property in the binding by specifying the new name in the `to()` chain:

```typescript
button.bind( 'isEnabled' ).to( command, 'isWorking' );
```

It is possible to bind more than one property at a time to shorten the code:

```typescript
button.bind( 'isEnabled', 'value' ).to( command );
```

which corresponds to:

```typescript
button.bind( 'isEnabled' ).to( command );
button.bind( 'value' ).to( command );
```

The binding can include more than one observable, combining multiple data sources in a custom callback:

```typescript
button.bind( 'isEnabled' ).to( command, 'isEnabled', ui, 'isVisible',
	( isCommandEnabled, isUIVisible ) => isCommandEnabled && isUIVisible );
```

Using a custom callback allows processing the value before passing it to the target property:

```typescript
button.bind( 'isEnabled' ).to( command, 'value', value => value === 'heading1' );
```

It is also possible to bind to the same property in an array of observables. To bind a `button` to multiple commands (also `Observables`) so that each and every one of them must be enabled for the button to become enabled, use the following code:

```typescript
button.bind( 'isEnabled' ).toMany( [ commandA, commandB, commandC ], 'isEnabled',
	( isAEnabled, isBEnabled, isCEnabled ) => isAEnabled && isBEnabled && isCEnabled );
```

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-utils/src/observablemixin.ts#L996)

#### Type parameters

* * `K1`
  * `K2`

#### Parameters

* `bindProperty1: K1`

  Observable property that will be bound to other observable(s).

* `bindProperty2: K2`

  Observable property that will be bound to other observable(s).

#### Returns

* `ObservableDualBindChain<K1, Autosave[ K1 ], K2, Autosave[ K2 ]>`

  The bind chain with the `to()` and `toMany()` methods.

<a id="function-bind:MANY_BIND">

### `bind( bindProperties ) → ObservableMultiBindChain` _(inherited)_

Binds [observable properties](#function-set:KEY_VALUE) to other objects implementing the [`Observable`](module_utils_observablemixin-Observable.md) interface.

Read more in the [dedicated](../framework/deep-dive/observables.md#property-bindings) guide covering the topic of property bindings with some additional examples.

Consider two objects: a `button` and an associated `command` (both `Observable`).

A simple property binding could be as follows:

```typescript
button.bind( 'isEnabled' ).to( command, 'isEnabled' );
```

or even shorter:

```typescript
button.bind( 'isEnabled' ).to( command );
```

which works in the following way:

* `button.isEnabled` **instantly equals** `command.isEnabled`,
* whenever `command.isEnabled` changes, `button.isEnabled` will immediately reflect its value.

**Note**: To release the binding, use [`unbind`](module_utils_observablemixin-Observable.md#function-unbind).

You can also "rename" the property in the binding by specifying the new name in the `to()` chain:

```typescript
button.bind( 'isEnabled' ).to( command, 'isWorking' );
```

It is possible to bind more than one property at a time to shorten the code:

```typescript
button.bind( 'isEnabled', 'value' ).to( command );
```

which corresponds to:

```typescript
button.bind( 'isEnabled' ).to( command );
button.bind( 'value' ).to( command );
```

The binding can include more than one observable, combining multiple data sources in a custom callback:

```typescript
button.bind( 'isEnabled' ).to( command, 'isEnabled', ui, 'isVisible',
	( isCommandEnabled, isUIVisible ) => isCommandEnabled && isUIVisible );
```

Using a custom callback allows processing the value before passing it to the target property:

```typescript
button.bind( 'isEnabled' ).to( command, 'value', value => value === 'heading1' );
```

It is also possible to bind to the same property in an array of observables. To bind a `button` to multiple commands (also `Observables`) so that each and every one of them must be enabled for the button to become enabled, use the following code:

```typescript
button.bind( 'isEnabled' ).toMany( [ commandA, commandB, commandC ], 'isEnabled',
	( isAEnabled, isBEnabled, isCEnabled ) => isAEnabled && isBEnabled && isCEnabled );
```

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-utils/src/observablemixin.ts#L1074)

#### Parameters

* `bindProperties: Array<'off' | 'set' | 'bind' | 'unbind' | 'decorate' | 'stopListening' | 'on' | 'once' | 'listenTo' | 'fire' | 'delegate' | 'stopDelegating' | 'destroy' | 'init' | 'editor' | 'isEnabled' | 'forceDisabled' | 'clearForceDisabled' | 'adapter' | 'state' | 'save'>`

  Observable properties that will be bound to other observable(s).

#### Returns

* `ObservableMultiBindChain`

  The bind chain with the `to()` and `toMany()` methods.

<a id="function-bind:SINGLE_BIND">

### `bind( bindProperty ) → ObservableSingleBindChain<K, Autosave[ K ]>` _(inherited)_

Binds [observable properties](#function-set:KEY_VALUE) to other objects implementing the [`Observable`](module_utils_observablemixin-Observable.md) interface.

Read more in the [dedicated](../framework/deep-dive/observables.md#property-bindings) guide covering the topic of property bindings with some additional examples.

Consider two objects: a `button` and an associated `command` (both `Observable`).

A simple property binding could be as follows:

```typescript
button.bind( 'isEnabled' ).to( command, 'isEnabled' );
```

or even shorter:

```typescript
button.bind( 'isEnabled' ).to( command );
```

which works in the following way:

* `button.isEnabled` **instantly equals** `command.isEnabled`,
* whenever `command.isEnabled` changes, `button.isEnabled` will immediately reflect its value.

**Note**: To release the binding, use [`unbind`](module_utils_observablemixin-Observable.md#function-unbind).

You can also "rename" the property in the binding by specifying the new name in the `to()` chain:

```typescript
button.bind( 'isEnabled' ).to( command, 'isWorking' );
```

It is possible to bind more than one property at a time to shorten the code:

```typescript
button.bind( 'isEnabled', 'value' ).to( command );
```

which corresponds to:

```typescript
button.bind( 'isEnabled' ).to( command );
button.bind( 'value' ).to( command );
```

The binding can include more than one observable, combining multiple data sources in a custom callback:

```typescript
button.bind( 'isEnabled' ).to( command, 'isEnabled', ui, 'isVisible',
	( isCommandEnabled, isUIVisible ) => isCommandEnabled && isUIVisible );
```

Using a custom callback allows processing the value before passing it to the target property:

```typescript
button.bind( 'isEnabled' ).to( command, 'value', value => value === 'heading1' );
```

It is also possible to bind to the same property in an array of observables. To bind a `button` to multiple commands (also `Observables`) so that each and every one of them must be enabled for the button to become enabled, use the following code:

```typescript
button.bind( 'isEnabled' ).toMany( [ commandA, commandB, commandC ], 'isEnabled',
	( isAEnabled, isBEnabled, isCEnabled ) => isAEnabled && isBEnabled && isCEnabled );
```

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-utils/src/observablemixin.ts#L918)

#### Type parameters

* `K`

#### Parameters

* `bindProperty: K`

  Observable property that will be bound to other observable(s).

#### Returns

* `ObservableSingleBindChain<K, Autosave[ K ]>`

  The bind chain with the `to()` and `toMany()` methods.

<a id="function-clearForceDisabled">

### `clearForceDisabled( id ) → void` _(inherited)_

Clears forced disable previously set through [`forceDisabled`](#function-forceDisabled). See [`forceDisabled`](#function-forceDisabled).

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-core/src/plugin.ts#L125)

#### Parameters

* `id: string`

  Unique identifier, equal to the one passed in [`forceDisabled`](#function-forceDisabled) call.

#### Returns

* `void`

<a id="function-decorate">

### `decorate( methodName ) → void` _(inherited)_

Turns the given methods of this object into event-based ones. This means that the new method will fire an event (named after the method) and the original action will be plugged as a listener to that event.

Read more in the [dedicated](../framework/deep-dive/observables.md#decorating-object-methods) guide covering the topic of decorating methods with some additional examples.

Decorating the method does not change its behavior (it only adds an event), but it allows to modify it later on by listening to the method's event.

For example, to cancel the method execution the event can be [stopped](module_utils_eventinfo-EventInfo.md#member-stop):

```typescript
class Foo extends ObservableMixin() {
	constructor() {
		super();
		this.decorate( 'method' );
	}

	method() {
		console.log( 'called!' );
	}
}

const foo = new Foo();
foo.on( 'method', ( evt ) => {
	evt.stop();
}, { priority: 'high' } );

foo.method(); // Nothing is logged.
```

**Note**: The high [priority](module_utils_priorities-PriorityString.md) listener has been used to execute this particular callback before the one which calls the original method (which uses the "normal" priority).

It is also possible to change the returned value:

```typescript
foo.on( 'method', ( evt ) => {
	evt.return = 'Foo!';
} );

foo.method(); // -> 'Foo'
```

Finally, it is possible to access and modify the arguments the method is called with:

```typescript
method( a, b ) {
	console.log( `${ a }, ${ b }`  );
}

// ...

foo.on( 'method', ( evt, args ) => {
	args[ 0 ] = 3;

	console.log( args[ 1 ] ); // -> 2
}, { priority: 'high' } );

foo.method( 1, 2 ); // -> '3, 2'
```

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-utils/src/observablemixin.ts#L1159)

#### Parameters

* `methodName: 'off' | 'set' | 'bind' | 'unbind' | 'decorate' | 'stopListening' | 'on' | 'once' | 'listenTo' | 'fire' | 'delegate' | 'stopDelegating' | 'destroy' | 'init' | 'editor' | 'isEnabled' | 'forceDisabled' | 'clearForceDisabled' | 'adapter' | 'state' | 'save'`

  Name of the method to decorate.

#### Returns

* `void`

<a id="function-delegate">

### `delegate( events ) → EmitterMixinDelegateChain` _(inherited)_

Delegates selected events to another [`Emitter`](module_utils_emittermixin-Emitter.md). For instance:

```typescript
emitterA.delegate( 'eventX' ).to( emitterB );
emitterA.delegate( 'eventX', 'eventY' ).to( emitterC );
```

then `eventX` is delegated (fired by) `emitterB` and `emitterC` along with `data`:

```typescript
emitterA.fire( 'eventX', data );
```

and `eventY` is delegated (fired by) `emitterC` along with `data`:

```typescript
emitterA.fire( 'eventY', data );
```

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-utils/src/emittermixin.ts#L539)

#### Parameters

* `events: Array<string>`

  Event names that will be delegated to another emitter.

#### Returns

* `EmitterMixinDelegateChain`

<a id="function-destroy">

### `destroy() → void`

Destroys the plugin.

**Note:** This method is optional. A plugin instance does not need to have it defined.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-autosave/src/autosave.ts#L222)

#### Returns

* `void`

<a id="function-fire">

### `fire( eventOrInfo, args ) → GetEventInfo<TEvent>[ 'return' ]` _(inherited)_

Fires an event, executing all callbacks registered for it.

The first parameter passed to callbacks is an [`EventInfo`](module_utils_eventinfo-EventInfo.md) object, followed by the optional `args` provided in the `fire()` method call.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-utils/src/emittermixin.ts#L512)

#### Type parameters

* `TEvent: extends BaseEvent`

  The type describing the event. See [`BaseEvent`](module_utils_emittermixin-BaseEvent.md).

#### Parameters

* `eventOrInfo: GetNameOrEventInfo<TEvent>`

  The name of the event or `EventInfo` object if event is delegated.

* `args: TEvent[ 'args' ]`

  Additional arguments to be passed to the callbacks.

#### Returns

* `GetEventInfo<TEvent>[ 'return' ]`

  By default the method returns `undefined`. However, the return value can be changed by listeners through modification of the [`evt.return`](module_utils_eventinfo-EventInfo.md#member-return)'s property (the event info is the first param of every callback).

<a id="function-forceDisabled">

### `forceDisabled( id ) → void` _(inherited)_

Disables the plugin.

Plugin may be disabled by multiple features or algorithms (at once). When disabling a plugin, unique id should be passed (e.g. feature name). The same identifier should be used when [enabling back](#function-clearForceDisabled) the plugin. The plugin becomes enabled only after all features [enabled it back](#function-clearForceDisabled).

Disabling and enabling a plugin:

```typescript
plugin.isEnabled; // -> true
plugin.forceDisabled( 'MyFeature' );
plugin.isEnabled; // -> false
plugin.clearForceDisabled( 'MyFeature' );
plugin.isEnabled; // -> true
```

Plugin disabled by multiple features:

```typescript
plugin.forceDisabled( 'MyFeature' );
plugin.forceDisabled( 'OtherFeature' );
plugin.clearForceDisabled( 'MyFeature' );
plugin.isEnabled; // -> false
plugin.clearForceDisabled( 'OtherFeature' );
plugin.isEnabled; // -> true
```

Multiple disabling with the same identifier is redundant:

```typescript
plugin.forceDisabled( 'MyFeature' );
plugin.forceDisabled( 'MyFeature' );
plugin.clearForceDisabled( 'MyFeature' );
plugin.isEnabled; // -> true
```

**Note:** some plugins or algorithms may have more complex logic when it comes to enabling or disabling certain plugins, so the plugin might be still disabled after [`clearForceDisabled`](#function-clearForceDisabled) was used.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-core/src/plugin.ts#L111)

#### Parameters

* `id: string`

  Unique identifier for disabling. Use the same id when [enabling back](#function-clearForceDisabled) the plugin.

#### Returns

* `void`

<a id="function-init">

### `init() → void`

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-autosave/src/autosave.ts#L174)

#### Returns

* `void`

<a id="function-listenTo:BASE_EMITTER">

### `listenTo( emitter, event, callback, options? ) → void` _(inherited)_

Registers a callback function to be executed when an event is fired in a specific (emitter) object.

Events can be grouped in namespaces using `:`. When namespaced event is fired, it additionally fires all callbacks for that namespace.

```typescript
// myEmitter.on( ... ) is a shorthand for myEmitter.listenTo( myEmitter, ... ).
myEmitter.on( 'myGroup', genericCallback );
myEmitter.on( 'myGroup:myEvent', specificCallback );

// genericCallback is fired.
myEmitter.fire( 'myGroup' );
// both genericCallback and specificCallback are fired.
myEmitter.fire( 'myGroup:myEvent' );
// genericCallback is fired even though there are no callbacks for "foo".
myEmitter.fire( 'myGroup:foo' );
```

An event callback can [stop the event](module_utils_eventinfo-EventInfo.md#member-stop) and set the [return value](module_utils_eventinfo-EventInfo.md#member-return) of the [`fire`](#function-fire) method.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-utils/src/emittermixin.ts#L475)

#### Type parameters

* `TEvent: extends BaseEvent`

  The type describing the event. See [`BaseEvent`](module_utils_emittermixin-BaseEvent.md).

#### Parameters

* `emitter: Emitter`

  The object that fires the event.

* `event: TEvent[ 'name' ]`

  The name of the event.

* `callback: GetCallback<TEvent>`

  The function to be called on event.

* `options?: GetCallbackOptions<TEvent>`

  Additional options.

#### Returns

* `void`

<a id="function-off">

### `off( event, callback ) → void` _(inherited)_

Stops executing the callback on the given event. Shorthand for [`this.stopListening( this, event, callback )`](#function-stopListening:BASE_STOP).

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-utils/src/emittermixin.ts#L444)

#### Parameters

* `event: string`

  The name of the event.

* `callback: Function`

  The function to stop being called.

#### Returns

* `void`

<a id="function-on">

### `on( event, callback, options? ) → void` _(inherited)_

Registers a callback function to be executed when an event is fired.

Shorthand for [`this.listenTo( this, event, callback, options )`](#function-listenTo:BASE_EMITTER) (it makes the emitter listen on itself).

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-utils/src/emittermixin.ts#L416)

#### Type parameters

* `TEvent: extends BaseEvent`

  The type descibing the event. See [`BaseEvent`](module_utils_emittermixin-BaseEvent.md).

#### Parameters

* `event: TEvent[ 'name' ]`

  The name of the event.

* `callback: GetCallback<TEvent>`

  The function to be called on event.

* `options?: GetCallbackOptions<TEvent>`

  Additional options.

#### Returns

* `void`

<a id="function-once">

### `once( event, callback, options? ) → void` _(inherited)_

Registers a callback function to be executed on the next time the event is fired only. This is similar to calling [`on`](#function-on) followed by [`off`](#function-off) in the callback.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-utils/src/emittermixin.ts#L431)

#### Type parameters

* `TEvent: extends BaseEvent`

  The type descibing the event. See [`BaseEvent`](module_utils_emittermixin-BaseEvent.md).

#### Parameters

* `event: TEvent[ 'name' ]`

  The name of the event.

* `callback: GetCallback<TEvent>`

  The function to be called on event.

* `options?: GetCallbackOptions<TEvent>`

  Additional options.

#### Returns

* `void`

<a id="function-save">

### `save() → Promise<void>`

Immediately calls autosave callback. All previously queued (debounced) callbacks are cleared. If there is already an autosave callback in progress, then the requested save will be performed immediately after the current callback finishes.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-autosave/src/autosave.ts#L236)

#### Returns

* `Promise<void>`

  A promise that will be resolved when the autosave callback is finished.

<a id="function-set:OBJECT">

### `set( values ) → void` _(inherited)_

Creates and sets the value of an observable properties of this object. Such a property becomes a part of the state and is observable.

It accepts a single object literal containing key/value pairs with properties to be set.

This method throws the `observable-set-cannot-override` error if the observable instance already has a property with the given property name. This prevents from mistakenly overriding existing properties and methods, but means that `foo.set( 'bar', 1 )` may be slightly slower than `foo.bar = 1`.

In TypeScript, those properties should be declared in class using `declare` keyword. In example:

```typescript
public declare myProp1: number;
public declare myProp2: string;

constructor() {
	this.set( {
		'myProp1: 2,
		'myProp2: 'foo'
	} );
}
```

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-utils/src/observablemixin.ts#L843)

#### Parameters

* `values: object & object`

  An object with `name=>value` pairs.

#### Returns

* `void`

<a id="function-set:KEY_VALUE">

### `set( name, value ) → void` _(inherited)_

Creates and sets the value of an observable property of this object. Such a property becomes a part of the state and is observable.

This method throws the `observable-set-cannot-override` error if the observable instance already has a property with the given property name. This prevents from mistakenly overriding existing properties and methods, but means that `foo.set( 'bar', 1 )` may be slightly slower than `foo.bar = 1`.

In TypeScript, those properties should be declared in class using `declare` keyword. In example:

```typescript
public declare myProp: number;

constructor() {
	this.set( 'myProp', 2 );
}
```

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-utils/src/observablemixin.ts#L815)

#### Type parameters

* `K`

#### Parameters

* `name: K`

  The property's name.

* `value: Autosave[ K ]`

  The property's value.

#### Returns

* `void`

<a id="function-stopDelegating">

### `stopDelegating( event?, emitter? ) → void` _(inherited)_

Stops delegating events. It can be used at different levels:

* To stop delegating all events.
* To stop delegating a specific event to all emitters.
* To stop delegating a specific event to a specific emitter.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-utils/src/emittermixin.ts#L552)

#### Parameters

* `event?: string`

  The name of the event to stop delegating. If omitted, stops it all delegations.

* `emitter?: Emitter`

  (requires `event`) The object to stop delegating a particular event to. If omitted, stops delegation of `event` to all emitters.

#### Returns

* `void`

<a id="function-stopListening:BASE_STOP">

### `stopListening( emitter?, event?, callback? ) → void` _(inherited)_

Stops listening for events. It can be used at different levels:

* To stop listening to a specific callback.
* To stop listening to a specific event.
* To stop listening to all events fired by a specific object.
* To stop listening to all events fired by all objects.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-utils/src/emittermixin.ts#L497)

#### Parameters

* `emitter?: Emitter`

  The object to stop listening to. If omitted, stops it for all objects.

* `event?: string`

  (Requires the `emitter`) The name of the event to stop listening to. If omitted, stops it for all events from `emitter`.

* `callback?: Function`

  (Requires the `event`) The function to be removed from the call list for the given `event`.

#### Returns

* `void`

<a id="function-unbind">

### `unbind( unbindProperties ) → void` _(inherited)_

Removes the binding created with [`bind`](#function-bind:SINGLE_BIND).

```typescript
// Removes the binding for the 'a' property.
A.unbind( 'a' );

// Removes bindings for all properties.
A.unbind();
```

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-utils/src/observablemixin.ts#L1090)

#### Parameters

* `unbindProperties: Array<'off' | 'set' | 'bind' | 'unbind' | 'decorate' | 'stopListening' | 'on' | 'once' | 'listenTo' | 'fire' | 'delegate' | 'stopDelegating' | 'destroy' | 'init' | 'editor' | 'isEnabled' | 'forceDisabled' | 'clearForceDisabled' | 'adapter' | 'state' | 'save'>`

  Observable properties to be unbound. All the bindings will be released if no properties are provided.

#### Returns

* `void`

<a id="function-_flush">

### `_flush() → void` _(private)_

Invokes the remaining `_save()` method call.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-autosave/src/autosave.ts#L245)

#### Returns

* `void`

<a id="function-_save">

### `_save() → Promise<void>` _(private)_

If the adapter is set and a new document version exists, the `_save()` method creates a pending action and calls the `adapter.save()` method. It waits for the result and then removes the created pending action.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-autosave/src/autosave.ts#L256)

#### Returns

* `Promise<void>`

  A promise that will be resolved when the autosave callback is finished.

<a id="function-_setPendingAction">

### `_setPendingAction() → void` _(private)_

Creates a pending action if it is not set already.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-autosave/src/autosave.ts#L327)

#### Returns

* `void`

<a id="events">

## Events

<a id="event-change:isEnabled">

### `change:isEnabled( eventInfo, name, value, oldValue )` _(inherited)_

Fired when the `isEnabled` property changed value.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-core/src/plugin.ts#L51)

#### Parameters

* `eventInfo: EventInfo`

  An object containing information about the fired event.

* `name: string`

  Name of the changed property (`isEnabled`).

* `value: boolean`

  New value of the `isEnabled` property with given key or `null`, if operation should remove property.

* `oldValue: boolean`

  Old value of the `isEnabled` property with given key or `null`, if property was not set before.

<a id="event-change:state">

### `change:state( eventInfo, name, value, oldValue )`

Fired when the `state` property changed value.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-autosave/src/autosave.ts#L78)

#### Parameters

* `eventInfo: EventInfo`

  An object containing information about the fired event.

* `name: string`

  Name of the changed property (`state`).

* `value: 'error' | 'waiting' | 'synchronized' | 'saving'`

  New value of the `state` property with given key or `null`, if operation should remove property.

* `oldValue: 'error' | 'waiting' | 'synchronized' | 'saving'`

  Old value of the `state` property with given key or `null`, if property was not set before.

<a id="event-change:%7Bproperty%7D">

### `change:{property}( eventInfo, name, value, oldValue )` _(inherited)_

Fired when a property changed value.

```typescript
observable.set( 'prop', 1 );

observable.on<ObservableChangeEvent<number>>( 'change:prop', ( evt, propertyName, newValue, oldValue ) => {
	console.log( `${ propertyName } has changed from ${ oldValue } to ${ newValue }` );
} );

observable.prop = 2; // -> 'prop has changed from 1 to 2'
```

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-utils/src/observablemixin.ts#L1190)

#### Parameters

* `eventInfo: EventInfo`

  An object containing information about the fired event.

* `name: string`

  The property name.

* `value: TValue`

  The new property value.

* `oldValue: TValue`

  The previous property value.

<a id="event-set:isEnabled">

### `set:isEnabled( eventInfo, name, value, oldValue )` _(inherited)_

Fired when the `isEnabled` property is going to be set but is not set yet (before the `change` event is fired).

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-core/src/plugin.ts#L51)

#### Parameters

* `eventInfo: EventInfo`

  An object containing information about the fired event.

* `name: string`

  Name of the changed property (`isEnabled`).

* `value: boolean`

  New value of the `isEnabled` property with given key or `null`, if operation should remove property.

* `oldValue: boolean`

  Old value of the `isEnabled` property with given key or `null`, if property was not set before.

<a id="event-set:state">

### `set:state( eventInfo, name, value, oldValue )`

Fired when the `state` property is going to be set but is not set yet (before the `change` event is fired).

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-autosave/src/autosave.ts#L78)

#### Parameters

* `eventInfo: EventInfo`

  An object containing information about the fired event.

* `name: string`

  Name of the changed property (`state`).

* `value: 'error' | 'waiting' | 'synchronized' | 'saving'`

  New value of the `state` property with given key or `null`, if operation should remove property.

* `oldValue: 'error' | 'waiting' | 'synchronized' | 'saving'`

  Old value of the `state` property with given key or `null`, if property was not set before.

<a id="event-set:%7Bproperty%7D">

### `set:{property}( eventInfo, name, value, oldValue )` _(inherited)_

Fired when a property value is going to be set but is not set yet (before the `change` event is fired).

You can control the final value of the property by using the [event's `return` property](module_utils_eventinfo-EventInfo.md#member-return).

```typescript
observable.set( 'prop', 1 );

observable.on<ObservableSetEvent<number>>( 'set:prop', ( evt, propertyName, newValue, oldValue ) => {
	console.log( `Value is going to be changed from ${ oldValue } to ${ newValue }` );
	console.log( `Current property value is ${ observable[ propertyName ] }` );

	// Let's override the value.
	evt.return = 3;
} );

observable.on<ObservableChangeEvent<number>>( 'change:prop', ( evt, propertyName, newValue, oldValue ) => {
	console.log( `Value has changed from ${ oldValue } to ${ newValue }` );
} );

observable.prop = 2; // -> 'Value is going to be changed from 1 to 2'
					 // -> 'Current property value is 1'
					 // -> 'Value has changed from 1 to 3'
```

**Note:** The event is fired even when the new value is the same as the old value.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-utils/src/observablemixin.ts#L1228)

#### Parameters

* `eventInfo: EventInfo`

  An object containing information about the fired event.

* `name: string`

  The property name.

* `value: TValue`

  The new property value.

* `oldValue: TValue`

  The previous property value.

---

Full index of the CKEditor 5 API reference: [llms.txt](llms.txt)