-
-
Notifications
You must be signed in to change notification settings - Fork 399
/
index.d.ts
63 lines (56 loc) · 1.88 KB
/
index.d.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
/*
* @license Apache-2.0
*
* Copyright (c) 2019 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.
*/
// TypeScript Version: 2.0
/// <reference types="@stdlib/types"/>
import { Collection } from '@stdlib/types/object';
/**
* Converts a collection to an object whose keys are determined by a provided function and whose values are the collection values, iterating from right to left.
*
* ## Notes
*
* - When invoked, the input function is provided two arguments:
*
* - `value`: collection value
* - `index`: collection index
*
* - If more than one element in a collection resolves to the same key, the key value is the collection element which last resolved to the key.
*
* - Object values are shallow copies.
*
* @param collection - input collection
* @param fcn - function to invoke
* @param thisArg - execution context
* @returns output object
*
* @example
* function toKey( value, index ) {
* console.log( '%d: %s', index, JSON.stringify( value ) );
* return value.name;
* }
*
* var collection = [
* { 'name': 'beep', 'a': 1 },
* { 'name': 'boop', 'b': 2 }
* ];
*
* var obj = keyByRight( collection, toKey );
* // returns { 'boop': { 'name': 'boop', 'b': 2 }, 'beep': { 'name': 'beep', 'a': 1 } }
*/
declare function keyByRight( collection: Collection, fcn: Function, thisArg?: any ): any; // tslint-disable-line max-line-length
// EXPORTS //
export = keyByRight;