-
-
Notifications
You must be signed in to change notification settings - Fork 400
/
index.d.ts
129 lines (121 loc) · 3.61 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
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
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
/*
* @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
/**
* Interface defining `isSafeIntegerArray` with methods for testing for primitive and object arrays, respectively.
*/
interface IsSafeIntegerArray {
/**
* Tests if a value is an array-like object containing only safe integers.
*
* @param value - value to test
* @returns boolean indicating whether value is an array-like object containing only safe integers
*
* @example
* var bool = isSafeIntegerArray( [ -3.0, new Number(0.0), 2.0 ] );
* // returns true
*
* @example
* var bool = isSafeIntegerArray( [ -3.0, '3.0' ] );
* // returns false
*/
( value: any ): boolean;
/**
* Tests if a value is an array-like object containing only primitive safe integer values.
*
* @param value - value to test
* @returns boolean indicating whether value is an array-like object containing only primitive safe integer values
*
* @example
* var bool = isSafeIntegerArray.primitives( [ -1.0, 10.0 ] );
* // returns true
*
* @example
* var bool = isSafeIntegerArray.primitives( [ -1.0, 0.0, 5.0 ] );
* // returns true
*
* @example
* var bool = isSafeIntegerArray.primitives( [ -3.0, new Number(-1.0) ] );
* // returns false
*/
primitives( value: any ): boolean;
/**
* Tests if a value is an array-like object containing only number objects having safe integer values.
*
* @param value - value to test
* @returns boolean indicating whether value is an array-like object containing only number objects having safe integer values
*
* @example
* var bool = isSafeIntegerArray.objects( [ new Number(1.0), new Number(3.0) ] );
* // returns true
*
* @example
* var bool = isSafeIntegerArray.objects( [ -1.0, 0.0, 3.0 ] );
* // returns false
*
* @example
* var bool = isSafeIntegerArray.objects( [ 3.0, new Number(-1.0) ] );
* // returns false
*/
objects( value: any ): boolean;
}
/**
* Tests if a value is an array-like object containing only safe integers.
*
* ## Notes
*
* - An integer valued number is "safe" when the number can be exactly represented as a double-precision floating-point number.
*
* @param value - value to test
* @returns boolean indicating whether value is an array-like object containing only safe integers
*
* @example
* var bool = isSafeIntegerArray( [ -3.0, new Number(0.0), 2.0 ] );
* // returns true
*
* @example
* var bool = isSafeIntegerArray( [ -3.0, '3.0' ] );
* // returns false
*
* @example
* var bool = isSafeIntegerArray.primitives( [ -1.0, 10.0 ] );
* // returns true
*
* @example
* var bool = isSafeIntegerArray.primitives( [ -1.0, 0.0, 5.0 ] );
* // returns true
*
* @example
* var bool = isSafeIntegerArray.primitives( [ -3.0, new Number(-1.0) ] );
* // returns false
*
* @example
* var bool = isSafeIntegerArray.objects( [ new Number(1.0), new Number(3.0) ] );
* // returns true
*
* @example
* var bool = isSafeIntegerArray.objects( [ -1.0, 0.0, 3.0 ] );
* // returns false
*
* @example
* var bool = isSafeIntegerArray.objects( [ 3.0, new Number(-1.0) ] );
* // returns false
*/
declare var isSafeIntegerArray: IsSafeIntegerArray;
// EXPORTS //
export = isSafeIntegerArray;