blockly/core/events/events_var_base.ts

/**
 * @license
 * Copyright 2018 Google LLC
 * SPDX-License-Identifier: Apache-2.0
 */

/**
 * @fileoverview Abstract class for a variable event.
 */

/**
 * Abstract class for a variable event.
 * @class
 */


import type {VariableModel} from '../variable_model';

import {Abstract as AbstractEvent} from './events_abstract';


/**
 * 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.
   * @return 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'];
  }
}