mirror of
https://github.com/google/blockly.git
synced 2026-01-09 10:00:09 +01:00
07db0c27d1
* feat: add IIcon interface * feat: add ISerializable interface * feat: add IHasBubble interface * feat: add type guards for icon interfaces * chore: PR comments
30 lines
858 B
TypeScript
30 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.
|
|
* @return 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;
|
|
}
|