121 lines
3.1 KiB
JavaScript
121 lines
3.1 KiB
JavaScript
|
/**
|
||
|
|
* @license Apache-2.0
|
||
|
|
*
|
||
|
|
* Copyright (c) 2018 The Stdlib Authors.
|
||
|
|
*
|
||
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||
|
|
* you may not use this file except in compliance with the License.
|
||
|
|
* You may obtain a copy of the License at
|
||
|
|
*
|
||
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||
|
|
*
|
||
|
|
* Unless required by applicable law or agreed to in writing, software
|
||
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||
|
|
* See the License for the specific language governing permissions and
|
||
|
|
* limitations under the License.
|
||
|
|
*/
|
||
|
|
|
||
|
|
'use strict';
|
||
|
|
|
||
|
|
// MODULES //
|
||
|
|
|
||
|
|
var isObjectLike = require( '@stdlib/assert/is-object-like' );
|
||
|
|
var isString = require( '@stdlib/assert/is-string' ).isPrimitive;
|
||
|
|
var isArray = require( '@stdlib/assert/is-array' );
|
||
|
|
var copy = require( './../../copy' );
|
||
|
|
var validate = require( './validate.js' );
|
||
|
|
var defaults = require( './defaults.json' );
|
||
|
|
var dset = require( './dset.js' );
|
||
|
|
|
||
|
|
|
||
|
|
// MAIN //
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Sets a nested property value.
|
||
|
|
*
|
||
|
|
* @param {ObjectLike} obj - input object
|
||
|
|
* @param {(string|Array)} path - key path
|
||
|
|
* @param {*} value - value to set
|
||
|
|
* @param {Options} [options] - function options
|
||
|
|
* @param {boolean} [options.create=false] - boolean indicating whether to create a path if the key path does not already exist
|
||
|
|
* @param {string} [options.sep='.'] - key path separator
|
||
|
|
* @throws {TypeError} second argument must be a string primitive or key array
|
||
|
|
* @throws {TypeError} options argument must be an object
|
||
|
|
* @throws {TypeError} must provide valid options
|
||
|
|
* @returns {boolean} boolean indicating if the property was successfully set
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* var obj = { 'a': { 'b': { 'c': 'd' } } };
|
||
|
|
* var bool = deepSet( obj, 'a.b.c', 'woot' );
|
||
|
|
* // returns true
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* var obj = { 'a': { 'b': { 'c': 'd' } } };
|
||
|
|
* var bool = deepSet( obj, 'a.beep.c', 'boop' );
|
||
|
|
* // returns false
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* var obj = { 'a': { 'b': { 'c': 'd' } } };
|
||
|
|
* var bool = deepSet( null, 'a.beep.c', 'boop' );
|
||
|
|
* // returns false
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* var obj = { 'a': { 'b': { 'c': 'd' } } };
|
||
|
|
* bool = deepSet( 'bap', 'a.beep.c', 'boop' );
|
||
|
|
* // returns false
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* var arr = [
|
||
|
|
* { 'a': [ {'x': 5} ] },
|
||
|
|
* { 'a': [ {'x': 10} ] }
|
||
|
|
* ];
|
||
|
|
* var bool = deepSet( arr, '1.a.0.x', 25 );
|
||
|
|
* // returns true
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* var obj = { 'a': { 'b': { 'c': 'd' } } };
|
||
|
|
* var bool = deepSet( obj, 'a/b/c', 'beep', {
|
||
|
|
* 'sep': '/'
|
||
|
|
* });
|
||
|
|
* // returns true
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* var obj = { 'a': { 'b': { 'c': 'd' } } };
|
||
|
|
* var bool = deepSet( obj, 'a.e.c', 'boop', {
|
||
|
|
* 'create': true
|
||
|
|
* });
|
||
|
|
* // returns true
|
||
|
|
*/
|
||
|
|
function deepSet( obj, path, value, options ) {
|
||
|
|
var isStr;
|
||
|
|
var props;
|
||
|
|
var opts;
|
||
|
|
var err;
|
||
|
|
if ( !isObjectLike( obj ) ) {
|
||
|
|
return false;
|
||
|
|
}
|
||
|
|
isStr = isString( path );
|
||
|
|
if ( !isStr && !isArray( path ) ) {
|
||
|
|
throw new TypeError( 'invalid argument. Key path must be a string primitive or a key array. Value: `' + path + '`.' );
|
||
|
|
}
|
||
|
|
opts = copy( defaults );
|
||
|
|
if ( arguments.length > 3 ) {
|
||
|
|
err = validate( opts, options );
|
||
|
|
if ( err ) {
|
||
|
|
throw err;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
if ( isStr ) {
|
||
|
|
props = path.split( opts.sep );
|
||
|
|
} else {
|
||
|
|
props = path;
|
||
|
|
}
|
||
|
|
return dset( obj, props, opts.create, value );
|
||
|
|
}
|
||
|
|
|
||
|
|
|
||
|
|
// EXPORTS //
|
||
|
|
|
||
|
|
module.exports = deepSet;
|