mirror of
https://github.com/google/blockly.git
synced 2026-01-06 16:40:07 +01:00
037eb59b89
* chore: add linting for tsdoc * chore: don't require types on return * chore: remove redundant fileoverview from ts * chore: change return to returns and add some newlines * chore: remove license tag * chore: don't require params/return docs * chore: remove spurious struct tags * Revert "chore: change return to returns and add some newlines" This reverts commitd6d8656a45. * chore: don't auto-add param names * chore: disable require-param bc it breaks on this * return to returns and add line breaks * chore: configure additional jsdoc rules * chore: run format * Revert "chore: remove license tag" This reverts commit173455588a. * chore: allow license tag format * chore: only require jsdoc on exported items * chore: add missing jsdoc or silence where needed * chore: run format * chore: lint fixes
66 lines
1.8 KiB
TypeScript
66 lines
1.8 KiB
TypeScript
/**
|
|
* @license
|
|
* Copyright 2021 Google LLC
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
/**
|
|
* The record type for an object containing functions for
|
|
* serializing part of the workspace.
|
|
*
|
|
* @namespace Blockly.serialization.ISerializer
|
|
*/
|
|
import * as goog from '../../closure/goog/goog.js';
|
|
goog.declareModuleId('Blockly.serialization.ISerializer');
|
|
|
|
import type {Workspace} from '../workspace.js';
|
|
|
|
|
|
/**
|
|
* Serializes and deserializes a plugin or system.
|
|
*
|
|
* @alias Blockly.serialization.ISerializer.ISerializer
|
|
*/
|
|
export interface ISerializer {
|
|
/**
|
|
* A priority value used to determine the order of deserializing state.
|
|
* More positive priorities are deserialized before less positive
|
|
* priorities. Eg if you have priorities (0, -10, 10, 100) the order of
|
|
* deserialiation will be (100, 10, 0, -10).
|
|
* If two serializers have the same priority, they are deserialized in an
|
|
* arbitrary order relative to each other.
|
|
*/
|
|
priority: number;
|
|
|
|
/* eslint-disable no-unused-vars, valid-jsdoc */
|
|
|
|
/**
|
|
* Saves the state of the plugin or system.
|
|
*
|
|
* @param workspace The workspace the system to serialize is associated with.
|
|
* @returns A JS object containing the system's state, or null if there is no
|
|
* state to record.
|
|
*/
|
|
save(workspace: Workspace): Object|null;
|
|
/* eslint-enable valid-jsdoc */
|
|
|
|
/**
|
|
* Loads the state of the plugin or system.
|
|
*
|
|
* @param state The state of the system to deserialize. This will always be
|
|
* non-null.
|
|
* @param workspace The workspace the system to deserialize is associated
|
|
* with.
|
|
*/
|
|
load(state: Object, workspace: Workspace): void;
|
|
|
|
/**
|
|
* Clears the state of the plugin or system.
|
|
*
|
|
* @param workspace The workspace the system to clear the state of is
|
|
* associated with.
|
|
*/
|
|
clear(workspace: Workspace): void;
|
|
}
|
|
/* eslint-enable no-unused-vars */
|