84 lines
2.1 KiB
JavaScript
84 lines
2.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 objectKeys = require( './../../keys' );
|
|
var isString = require( '@stdlib/assert/is-string' ).isPrimitive;
|
|
var isStringArray = require( '@stdlib/assert/is-string-array' ).primitives;
|
|
var indexOf = require( './../../index-of' );
|
|
|
|
|
|
// MAIN //
|
|
|
|
/**
|
|
* Returns a partial object copy excluding specified keys.
|
|
*
|
|
* @param {Object} obj - source object
|
|
* @param {(string|StringArray)} keys - keys to exclude
|
|
* @throws {TypeError} first argument must be an object
|
|
* @throws {TypeError} second argument must be either a string or an array of strings
|
|
* @returns {Object} new object
|
|
*
|
|
* @example
|
|
* var obj1 = {
|
|
* 'a': 1,
|
|
* 'b': 2
|
|
* };
|
|
*
|
|
* var obj2 = omit( obj1, 'b' );
|
|
* // returns { 'a': 1 }
|
|
*/
|
|
function omit( obj, keys ) {
|
|
var ownKeys;
|
|
var out;
|
|
var key;
|
|
var i;
|
|
if ( typeof obj !== 'object' || obj === null ) {
|
|
throw new TypeError( 'invalid argument. First argument must be an object. Value: `'+obj+'`.' );
|
|
}
|
|
ownKeys = objectKeys( obj );
|
|
out = {};
|
|
if ( isString( keys ) ) {
|
|
for ( i = 0; i < ownKeys.length; i++ ) {
|
|
key = ownKeys[ i ];
|
|
if ( key !== keys ) {
|
|
out[ key ] = obj[ key ];
|
|
}
|
|
}
|
|
return out;
|
|
}
|
|
if ( isStringArray( keys ) ) {
|
|
for ( i = 0; i < ownKeys.length; i++ ) {
|
|
key = ownKeys[ i ];
|
|
if ( indexOf( keys, key ) === -1 ) {
|
|
out[ key ] = obj[ key ];
|
|
}
|
|
}
|
|
return out;
|
|
}
|
|
throw new TypeError( 'invalid argument. Second argument must be either a string primitive or an array of string primitives. Value: `'+keys+'`.' );
|
|
}
|
|
|
|
|
|
// EXPORTS //
|
|
|
|
module.exports = omit;
|