mirror of
https://github.com/google/blockly.git
synced 2026-01-04 23:50:12 +01:00
42b8c6e3ab
* chore: remove suppress annotations * chore: remove fileoverview annotation * chore: remove other unused annotations * chore: change return to returns * chore: enable tag linting
29 lines
858 B
TypeScript
29 lines
858 B
TypeScript
/**
|
|
* @license
|
|
* Copyright 2023 Google LLC
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
export interface ISerializable {
|
|
/**
|
|
* @param doFullSerialization If true, this signals that any backing data
|
|
* structures used by this ISerializable should also be serialized. This
|
|
* is used for copy-paste.
|
|
* @returns a JSON serializable value that records the icon's state.
|
|
*/
|
|
saveState(doFullSerialization: boolean): any;
|
|
|
|
/**
|
|
* Takes in a JSON serializable value and sets the ISerializable's state
|
|
* based on that.
|
|
*
|
|
* @param state The state to apply to the ISerializable.
|
|
*/
|
|
loadState(state: any): void;
|
|
}
|
|
|
|
/** Type guard that checks whether the given object is a ISerializable. */
|
|
export function isSerializable(obj: any): obj is ISerializable {
|
|
return obj.saveState !== undefined && obj.loadState !== undefined;
|
|
}
|