mirror of
https://github.com/google/blockly.git
synced 2026-01-05 08:00:09 +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.5 KiB
TypeScript
66 lines
1.5 KiB
TypeScript
/**
|
|
* @license
|
|
* Copyright 2018 Google LLC
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
/**
|
|
* Abstract class for a variable event.
|
|
*
|
|
* @class
|
|
*/
|
|
import * as goog from '../../closure/goog/goog.js';
|
|
goog.declareModuleId('Blockly.Events.VarBase');
|
|
|
|
import type {VariableModel} from '../variable_model.js';
|
|
|
|
import {Abstract as AbstractEvent} from './events_abstract.js';
|
|
|
|
|
|
/**
|
|
* Abstract class for a variable event.
|
|
*
|
|
* @alias Blockly.Events.VarBase
|
|
*/
|
|
export class VarBase extends AbstractEvent {
|
|
override isBlank: AnyDuringMigration;
|
|
varId: string;
|
|
override workspaceId: string;
|
|
|
|
/**
|
|
* @param opt_variable The variable this event corresponds to. Undefined for
|
|
* a blank event.
|
|
*/
|
|
constructor(opt_variable?: VariableModel) {
|
|
super();
|
|
this.isBlank = typeof opt_variable === 'undefined';
|
|
|
|
/** The variable id for the variable this event pertains to. */
|
|
this.varId = this.isBlank ? '' : opt_variable!.getId();
|
|
|
|
/** The workspace identifier for this event. */
|
|
this.workspaceId = this.isBlank ? '' : opt_variable!.workspace.id;
|
|
}
|
|
|
|
/**
|
|
* Encode the event as JSON.
|
|
*
|
|
* @returns JSON representation.
|
|
*/
|
|
override toJson(): AnyDuringMigration {
|
|
const json = super.toJson();
|
|
json['varId'] = this.varId;
|
|
return json;
|
|
}
|
|
|
|
/**
|
|
* Decode the JSON event.
|
|
*
|
|
* @param json JSON representation.
|
|
*/
|
|
override fromJson(json: AnyDuringMigration) {
|
|
super.fromJson(json);
|
|
this.varId = json['varId'];
|
|
}
|
|
}
|