kingjs/descriptor.nested.freeze
@Freezes paths of a tree.
Usage
Freeze a tree of descriptors like this:
'use strict';
var freeze = require('@kingjs/descriptor.nested.freeze');
var values = {
alice: {
pet: { name: 'tiger' }
},
bob: {
pet: { name: 'snuggles' }
},
chris: {
pet: { name: 'spike' }
},
}
freeze(values, {
'*': { pet: null }
});
values;
result:
{
alice: {
pet: { name: 'tiger' }
},
bob: {
pet: { name: 'snuggles' }
},
chris: {
pet: { name: 'spike' }
},
}
API
declare function freeze(
tree: NestedDescriptor,
paths: NestedDescriptor
): void
Interfaces
-
NestedDescriptor
: see @kingjs/descriptor/nested
Parameters
-
tree
: The tree whose nodes will be frozen. -
paths
: The paths of the tree to freeze.
Install
With npm installed, run
$ npm install @kingjs/descriptor.nested.freeze
License
MIT