time-to-botec/squiggle/node_modules/@stdlib/utils/deep-get/lib/factory.js

95 lines
2.3 KiB
JavaScript
Raw Normal View History

/**
* @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 isString = require( '@stdlib/assert/is-string' ).isPrimitive;
var isArray = require( '@stdlib/assert/is-array' );
var isObjectLike = require( '@stdlib/assert/is-object-like' );
var copy = require( './../../copy' );
var validate = require( './validate.js' );
var defaults = require( './defaults.json' );
var dget = require( './dget.js' );
// MAIN //
/**
* Returns a function for retrieving a nested property value.
*
* @param {(string|Array)} path - key path
* @param {Options} [options] - function options
* @param {string} [options.sep='.'] - key path separator
* @throws {TypeError} first argument must be a string primitive or key array
* @throws {TypeError} options argument must be an object
* @throws {TypeError} must provide valid options
* @returns {Function} deep get function
*
* @example
* var dget = factory( 'a/b/c', {
* 'sep': '/'
* });
*/
function factory( path, options ) {
var isStr;
var props;
var opts;
var err;
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 > 1 ) {
err = validate( opts, options );
if ( err ) {
throw err;
}
}
if ( isStr ) {
props = path.split( opts.sep );
} else {
props = path;
}
return deepGet;
/**
* Returns a nested property value.
*
* @private
* @param {ObjectLike} obj - input object
* @returns {*} nested property value
*
* @example
* var obj = { 'a': { 'b': { 'c': 'd' } } };
* var val = deepGet( obj );
*/
function deepGet( obj ) {
if ( isObjectLike( obj ) ) {
return dget( obj, props );
}
}
}
// EXPORTS //
module.exports = factory;