mirror of
https://github.com/kremalicious/metamask-extension.git
synced 2024-12-23 09:52:26 +01:00
ac01c5c89a
* Specify type before parameter name
Various JSDoc `@param` entries were specified as `name {type}` rather
than `{type} name`.
A couple of `@return` entries have been given types as well.
* Use JSDoc optional syntax rather than Closure syntax
* Use @returns rather than @return
* Use consistent built-in type capitalization
Primitive types are lower-case, and Object is upper-case.
* Separate param/return description with a dash
51 lines
1.6 KiB
JavaScript
51 lines
1.6 KiB
JavaScript
import clone from 'clone'
|
|
|
|
export default getObjStructure
|
|
|
|
// This will create an object that represents the structure of the given object
|
|
// it replaces all values with the result of their type
|
|
|
|
// {
|
|
// "data": {
|
|
// "CurrencyController": {
|
|
// "conversionDate": "number",
|
|
// "conversionRate": "number",
|
|
// "currentCurrency": "string"
|
|
// }
|
|
// }
|
|
|
|
/**
|
|
* Creates an object that represents the structure of the given object. It replaces all values with the result of their
|
|
* type.
|
|
*
|
|
* @param {Object} obj - The object for which a 'structure' will be returned. Usually a plain object and not a class.
|
|
* @returns {Object} - The "mapped" version of a deep clone of the passed object, with each non-object property value
|
|
* replaced with the javascript type of that value.
|
|
*
|
|
*/
|
|
function getObjStructure (obj) {
|
|
const structure = clone(obj)
|
|
return deepMap(structure, (value) => {
|
|
return value === null ? 'null' : typeof value
|
|
})
|
|
}
|
|
|
|
/**
|
|
* Modifies all the properties and deeply nested of a passed object. Iterates recursively over all nested objects and
|
|
* their properties, and covers the entire depth of the object. At each property value which is not an object is modified.
|
|
*
|
|
* @param {Object} target - The object to modify
|
|
* @param {Function} visit - The modifier to apply to each non-object property value
|
|
* @returns {Object} - The modified object
|
|
*/
|
|
function deepMap (target = {}, visit) {
|
|
Object.entries(target).forEach(([key, value]) => {
|
|
if (typeof value === 'object' && value !== null) {
|
|
target[key] = deepMap(value, visit)
|
|
} else {
|
|
target[key] = visit(value)
|
|
}
|
|
})
|
|
return target
|
|
}
|