time-to-botec

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

index.js (1331B)


      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 * Invert an object, such that keys become values and values become keys.
     23 *
     24 * @module @stdlib/utils/object-inverse
     25 *
     26 * @example
     27 * var invert = require( '@stdlib/utils/object-inverse' );
     28 *
     29 * var out = invert({
     30 *     'a': 'beep',
     31 *     'b': 'boop'
     32 * });
     33 * // returns { 'beep': 'a', 'boop': 'b' }
     34 *
     35 * out = invert({
     36 *     'a': 'beep',
     37 *     'b': 'beep'
     38 * });
     39 * // returns { 'beep': [ 'a', 'b' ] }
     40 *
     41 * var obj = {};
     42 * obj.a = 'beep';
     43 * obj.b = 'boop';
     44 * obj.c = 'beep'; // inserted after `a`
     45 *
     46 * out = invert( obj, {
     47 *     'duplicates': false
     48 * });
     49 * // returns { 'beep': 'c', 'boop': 'b' }
     50 */
     51 
     52 // MODULES //
     53 
     54 var invert = require( './object_inverse.js' );
     55 
     56 
     57 // EXPORTS //
     58 
     59 module.exports = invert;