Files
blockly/core/interfaces/i_serializer.ts
Christopher Allen b0a7c004a9 refactor(build): Delete Closure Library (#7415)
* fix(build): Restore erroneously-deleted filter function

  This was deleted in PR #7406 as it was mainly being used to
  filter core/ vs. test/mocha/ deps into separate deps files -
  but it turns out also to be used for filtering error
  messages too.  Oops.

* refactor(tests): Migrate advanced compilation test to ES Modules

* refactor(build): Migrate main.js to TypeScript

  This turns out to be pretty straight forward, even if it would
  cause crashing if one actually tried to import this module
  instead of just feeding it to Closure Compiler.

* chore(build): Remove goog.declareModuleId calls

  Replace goog.declareModuleId calls with a comment recording the
  former module ID for posterity (or at least until we decide
  how to reformat the renamings file.

* chore(tests): Delete closure/goog/*

  For the moment we still need something to serve as base.js for
  the benefit of closure-make-deps, so we keep a vestigial
  base.js around, containing only the @provideGoog declaration.

* refactor(build): Remove vestigial base.js

  By changing slightly the command line arguments to
  closure-make-deps and closure-calculate-chunks the need to have
  any base.js is eliminated.

* chore: Typo fix for PR #7415
2023-08-31 00:24:47 +01:00

56 lines
1.6 KiB
TypeScript

/**
* @license
* Copyright 2021 Google LLC
* SPDX-License-Identifier: Apache-2.0
*/
// Former goog.module ID: Blockly.serialization.ISerializer
import type {Workspace} from '../workspace.js';
/**
* Serializes and deserializes a plugin or system.
*/
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 */