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
84
85
86
87
88
89
90
91
92
93
94
|
/*
* @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 deepPluck = require( './index' );
// TESTS //
// The function returns an array...
{
const arr1 = [
{ 'a': { 'b': { 'c': 1 } } },
{ 'a': { 'b': { 'c': 2 } } }
];
deepPluck( arr1, 'a.b.c' ); // $ExpectType any[]
const arr2 = [
{ 'a': [ 0, 1, 2 ] },
{ 'a': [ 3, 4, 5 ] }
];
deepPluck( arr2, [ 'a', 1 ] ); // $ExpectType any[]
}
// The compiler throws an error if the function is provided a second argument which is not a string or an array...
{
const arr = [
{ 'a': { 'b': { 'c': 1 } } },
{ 'a': { 'b': { 'c': 2 } } }
];
deepPluck( arr, 3.12 ); // $ExpectError
deepPluck( arr, {} ); // $ExpectError
deepPluck( arr, false ); // $ExpectError
deepPluck( arr, true ); // $ExpectError
deepPluck( arr, ( x: number ): number => x ); // $ExpectError
}
// The compiler throws an error if the function is provided a third argument which is not an object...
{
const arr = [
{ 'a': { 'b': { 'c': 1 } } },
{ 'a': { 'b': { 'c': 2 } } }
];
deepPluck( arr, 'a.b.c', null ); // $ExpectError
}
// The compiler throws an error if the function is provided a `copy` option which is not a boolean...
{
const arr = [
{ 'a': { 'b': { 'c': 1 } } },
{ 'a': { 'b': { 'c': 2 } } }
];
deepPluck( arr, 'a.b.c', { 'copy': '5' } ); // $ExpectError
deepPluck( arr, 'a.b.c', { 'copy': 123 } ); // $ExpectError
deepPluck( arr, 'a.b.c', { 'copy': null } ); // $ExpectError
deepPluck( arr, 'a.b.c', { 'copy': [] } ); // $ExpectError
deepPluck( arr, 'a.b.c', { 'copy': {} } ); // $ExpectError
deepPluck( arr, 'a.b.c', { 'copy': ( x: number ): number => x } ); // $ExpectError
}
// The compiler throws an error if the function is provided a `sep` option which is not a string...
{
const arr = [
{ 'a': { 'b': { 'c': 1 } } },
{ 'a': { 'b': { 'c': 2 } } }
];
deepPluck( arr, 'a.b.c', { 'sep': true } ); // $ExpectError
deepPluck( arr, 'a.b.c', { 'sep': false } ); // $ExpectError
deepPluck( arr, 'a.b.c', { 'sep': 123 } ); // $ExpectError
deepPluck( arr, 'a.b.c', { 'sep': null } ); // $ExpectError
deepPluck( arr, 'a.b.c', { 'sep': [] } ); // $ExpectError
deepPluck( arr, 'a.b.c', { 'sep': {} } ); // $ExpectError
deepPluck( arr, 'a.b.c', { 'sep': ( x: number ): number => x } ); // $ExpectError
}
// The compiler throws an error if the function is provided insufficient arguments...
{
deepPluck(); // $ExpectError
deepPluck( [] ); // $ExpectError
}
|
