time-to-botec

Benchmark sampling in different programming languages
Log | Files | Refs | README

index.js (1342B)


      1 /**
      2 * @license Apache-2.0
      3 *
      4 * Copyright (c) 2018 The Stdlib Authors.
      5 *
      6 * Licensed under the Apache License, Version 2.0 (the "License");
      7 * you may not use this file except in compliance with the License.
      8 * You may obtain a copy of the License at
      9 *
     10 *    http://www.apache.org/licenses/LICENSE-2.0
     11 *
     12 * Unless required by applicable law or agreed to in writing, software
     13 * distributed under the License is distributed on an "AS IS" BASIS,
     14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     15 * See the License for the specific language governing permissions and
     16 * limitations under the License.
     17 */
     18 
     19 'use strict';
     20 
     21 /**
     22 * Set a nested property value.
     23 *
     24 * @module @stdlib/utils/deep-set
     25 *
     26 * @example
     27 * var deepSet = require( '@stdlib/utils/deep-set' );
     28 *
     29 * var obj = { 'a': { 'b': { 'c': 'd' } } };
     30 * var bool = deepSet( obj, 'a.b.c', 'beep' );
     31 * // returns true
     32 *
     33 * var dset = deepSet.factory( 'a/b/c', {
     34 *     'create': true,
     35 *     'sep': '/'
     36 * });
     37 *
     38 * obj = { 'a': { 'b': { 'c': 'd' } } };
     39 *
     40 * bool = dset( obj, 'beep' );
     41 * // returns true
     42 */
     43 
     44 // MODULES //
     45 
     46 var setReadOnly = require( './../../define-nonenumerable-read-only-property' );
     47 var deepSet = require( './deep_set.js' );
     48 var factory = require( './factory.js' );
     49 
     50 
     51 // MAIN //
     52 
     53 setReadOnly( deepSet, 'factory', factory );
     54 
     55 
     56 // EXPORTS //
     57 
     58 module.exports = deepSet;