mirror of
https://github.com/google/blockly.git
synced 2026-01-09 18:10:08 +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
97 lines
2.8 KiB
TypeScript
97 lines
2.8 KiB
TypeScript
/**
|
|
* @license
|
|
* Copyright 2019 Google LLC
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
/**
|
|
* Utility methods for objects.
|
|
*
|
|
* @namespace Blockly.utils.object
|
|
*/
|
|
import * as goog from '../../closure/goog/goog.js';
|
|
goog.declareModuleId('Blockly.utils.object');
|
|
|
|
import * as deprecation from './deprecation.js';
|
|
|
|
|
|
/**
|
|
* Inherit the prototype methods from one constructor into another.
|
|
*
|
|
* @param childCtor Child class.
|
|
* @param parentCtor Parent class.
|
|
* @suppress {strictMissingProperties} superClass_ is not defined on Function.
|
|
* @alias Blockly.utils.object.inherits
|
|
*/
|
|
export function inherits(childCtor: Function, parentCtor: Function) {
|
|
// Set a .superClass_ property so that methods can call parent methods
|
|
// without hard-coding the parent class name.
|
|
// Could be replaced by ES6's super().
|
|
// AnyDuringMigration because: Property 'superClass_' does not exist on type
|
|
// 'Function'.
|
|
(childCtor as AnyDuringMigration).superClass_ = parentCtor.prototype;
|
|
|
|
// Link the child class to the parent class so that static methods inherit.
|
|
Object.setPrototypeOf(childCtor, parentCtor);
|
|
|
|
// Replace the child constructor's prototype object with an instance
|
|
// of the parent class.
|
|
childCtor.prototype = Object.create(parentCtor.prototype);
|
|
childCtor.prototype.constructor = childCtor;
|
|
}
|
|
// Alternatively, one could use this instead:
|
|
// Object.setPrototypeOf(childCtor.prototype, parentCtor.prototype);
|
|
|
|
/**
|
|
* Copies all the members of a source object to a target object.
|
|
*
|
|
* @param target Target.
|
|
* @param source Source.
|
|
* @alias Blockly.utils.object.mixin
|
|
*/
|
|
export function mixin(target: AnyDuringMigration, source: AnyDuringMigration) {
|
|
deprecation.warn(
|
|
'Blockly.utils.object.mixin', 'May 2022', 'May 2023', 'Object.assign');
|
|
for (const x in source) {
|
|
target[x] = source[x];
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Complete a deep merge of all members of a source object with a target object.
|
|
*
|
|
* @param target Target.
|
|
* @param source Source.
|
|
* @returns The resulting object.
|
|
* @alias Blockly.utils.object.deepMerge
|
|
*/
|
|
export function deepMerge(
|
|
target: AnyDuringMigration,
|
|
source: AnyDuringMigration): AnyDuringMigration {
|
|
for (const x in source) {
|
|
if (source[x] !== null && typeof source[x] === 'object') {
|
|
target[x] = deepMerge(target[x] || Object.create(null), source[x]);
|
|
} else {
|
|
target[x] = source[x];
|
|
}
|
|
}
|
|
return target;
|
|
}
|
|
|
|
/**
|
|
* Returns an array of a given object's own enumerable property values.
|
|
*
|
|
* @param obj Object containing values.
|
|
* @returns Array of values.
|
|
* @alias Blockly.utils.object.values
|
|
*/
|
|
export function values(obj: AnyDuringMigration): AnyDuringMigration[] {
|
|
if (Object.values) {
|
|
return Object.values(obj);
|
|
}
|
|
// Fallback for IE.
|
|
return Object.keys(obj).map(function(e) {
|
|
return obj[e];
|
|
});
|
|
}
|