Class SerializableCommand`Abstract`

A command that can be serialized to or deserialized from JSON. To allow a command to be deserialized, SerializableCommand.register must be called for each SerializableCommand.

This is used to allow collaborative editing.

Hierarchy (view full)

Command
- SerializableCommand
  - Duplicate
  - Erase

Index

Constructors

Properties

Methods

apply description onDrop serialize serializeToJSON unapply deserialize register union

Constructors

constructor

new SerializableCommand(commandTypeId): SerializableCommand
Parameters
- commandTypeId: string
  A unique identifier for this command.
Returns SerializableCommand
Overrides Command.constructor
- Defined in commands/SerializableCommand.ts:16

Properties

`Static` `Readonly`empty

empty: (Anonymous class) = ...

Methods

`Abstract`apply

apply(editor): void | Promise<void>
Parameters
- editor: Editor
Returns void | Promise<void>
Inherited from Command.apply
- Defined in commands/Command.ts:10

`Abstract`description

description(editor, localizationTable): string
Parameters
- editor: Editor
- localizationTable: EditorLocalization
Returns string
Inherited from Command.description
- Defined in commands/Command.ts:16

onDrop

onDrop(_editor): void
Called when the command is being deleted
Parameters
- _editor: Editor
Returns void
Inherited from Command.onDrop
- Defined in commands/Command.ts:14

serialize

serialize(): Record<string | symbol, any>
Convert this command to an object that can be passed to JSON.stringify.

Do not rely on the stability of the optupt of this function — it can change form without a major version increase.

Returns Record<string | symbol, any>
- Defined in commands/SerializableCommand.ts:35

`Protected` `Abstract`serializeToJSON

serializeToJSON(): string | any[] | Record<string, any>
Returns string | any[] | Record<string, any>
- Defined in commands/SerializableCommand.ts:28

`Abstract`unapply

unapply(editor): void | Promise<void>
Parameters
- editor: Editor
Returns void | Promise<void>
Inherited from Command.unapply
- Defined in commands/Command.ts:11

`Static`deserialize

deserialize(data, editor): SerializableCommand
Convert a string containing JSON data (or the output of JSON.parse) into a Command.

Implementations should assume that data is untrusted.
Parameters
- data: string | Record<string, any>
- editor: Editor
Returns SerializableCommand
- Defined in commands/SerializableCommand.ts:46

`Static`register

register(commandTypeId, deserialize): void
Register a deserialization callback. This must be called at least once for every subclass of SerializableCommand.
Parameters
- commandTypeId: string
- deserialize: DeserializationCallback
Returns void
- Defined in commands/SerializableCommand.ts:59

`Static`union

union(a, b): Command
Parameters
- a: Command
- b: Command
Returns Command
Deprecated
Use uniteCommands
Inherited from Command.union
- Defined in commands/Command.ts:19

OpenSource licenses