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 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83
|
/*
* @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.
*/
import groupBy = require( './index' );
const indicator = ( v: string ): string => v[ 0 ];
// TESTS //
// The function returns an object...
{
groupBy( [ 'beep', 'boop', 'foo', 'bar' ], indicator ); // $ExpectType any
groupBy( [], indicator ); // $ExpectType any
const opts = {
'returns': 'indices' as 'indices'
};
groupBy( [ 'beep', 'boop', 'foo', 'bar' ], opts, indicator ); // $ExpectType any
}
// The compiler throws an error if the function is provided a first argument which is not a collection...
{
groupBy( true, indicator ); // $ExpectError
groupBy( false, indicator ); // $ExpectError
groupBy( 5, indicator ); // $ExpectError
}
// The compiler throws an error if the function is provided a last argument which is not a function...
{
const arr = [ 'beep', 'boop', 'foo', 'bar' ];
groupBy( arr, false ); // $ExpectError
groupBy( arr, true ); // $ExpectError
groupBy( arr, 32 ); // $ExpectError
groupBy( arr, 'abc' ); // $ExpectError
groupBy( arr, [] ); // $ExpectError
groupBy( arr, {} ); // $ExpectError
groupBy( arr, {}, false ); // $ExpectError
groupBy( arr, {}, true ); // $ExpectError
groupBy( arr, {}, 32 ); // $ExpectError
groupBy( arr, {}, 'abc' ); // $ExpectError
groupBy( arr, {}, [] ); // $ExpectError
groupBy( arr, {}, {} ); // $ExpectError
}
// The compiler throws an error if the function is provided an options argument which is not an object...
{
const arr = [ 'beep', 'boop', 'foo', 'bar' ];
groupBy( arr, null, indicator ); // $ExpectError
}
// The compiler throws an error if the function is provided a `returns` option which is not one of 'indices', 'values', or '*'...
{
const arr = [ 'beep', 'boop', 'foo', 'bar' ];
groupBy( arr, { 'returns': '5' }, indicator ); // $ExpectError
groupBy( arr, { 'returns': 123 }, indicator ); // $ExpectError
groupBy( arr, { 'returns': [] }, indicator ); // $ExpectError
groupBy( arr, { 'returns': {} }, indicator ); // $ExpectError
groupBy( arr, { 'returns': ( x: number ): number => x }, indicator ); // $ExpectError
}
// The compiler throws an error if the function is provided an invalid number of arguments...
{
const arr = [ 'beep', 'boop', 'foo', 'bar' ];
groupBy(); // $ExpectError
groupBy( arr ); // $ExpectError
groupBy( arr, {}, indicator, 16 ); // $ExpectError
}
|