File: index.d.ts

package info (click to toggle)
node-stdlib 0.0.96%2Bds1%2B~cs0.0.429-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 421,476 kB
  • sloc: javascript: 1,562,831; ansic: 109,702; lisp: 49,823; cpp: 27,224; python: 7,871; sh: 6,807; makefile: 6,089; fortran: 3,102; awk: 387
file content (133 lines) | stat: -rw-r--r-- 3,105 bytes parent folder | download
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
130
131
132
133
/*
* @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 `isPositiveZero` with methods for testing for primitives and objects, respectively.
*/
interface IsPositiveZero {
	/**
	* Tests if a value is equal to positive zero.
	*
	* @param value - value to test
	* @returns boolean indicating whether value is equal to positive zero
	*
	* @example
	* var bool = isPositiveZero( 0.0 );
	* // returns true
	*
	* @example
	* var bool = isPositiveZero( new Number( 0.0 ) );
	* // returns true
	*
	* @example
	* var bool = isPositiveZero( -3.14 );
	* // returns false
	*
	* @example
	* var bool = isPositiveZero( 5.0 );
	* // returns false
	*
	* @example
	* var bool = isPositiveZero( -0.0 );
	* // returns false
	*
	* @example
	* var bool = isPositiveZero( null );
	* // returns false
	*/
	( value: any ): boolean;

	/**
	* Tests if a value is a number primitive equal to positive zero.
	*
	* @param value - value to test
	* @returns boolean indicating if a value is a number primitive equal to positive zero
	*
	* @example
	* var bool = isPositiveZero.isPrimitive( 0.0 );
	* // returns true
	*
	* @example
	* var bool = isPositiveZero.isPrimitive( new Number( 0.0 ) );
	* // returns false
	*/
	isPrimitive( value: any ): boolean;

	/**
	* Tests if a value is a number object having a value equal to positive zero.
	*
	* @param value - value to test
	* @returns boolean indicating if a value is a number object having a value equal to positive zero
	*
	* @example
	* var bool = isPositiveZero.isObject( 0.0 );
	* // returns false
	*
	* @example
	* var bool = isPositiveZero.isObject( new Number( 0.0 ) );
	* // returns true
	*/
	isObject( value: any ): boolean;
}

/**
* Tests if a value is equal to positive zero.
*
* @param value - value to test
* @returns boolean indicating whether value is equal to positive zero
*
* @example
* var bool = isPositiveZero( 0.0 );
* // returns true
*
* @example
* var bool = isPositiveZero( new Number( 0.0 ) );
* // returns true
*
* @example
* var bool = isPositiveZero( -3.14 );
* // returns false
*
* @example
* var bool = isPositiveZero( 5.0 );
* // returns false
*
* @example
* var bool = isPositiveZero( -0.0 );
* // returns false
*
* @example
* var bool = isPositiveZero( null );
* // returns false
*
* @example
* var bool = isPositiveZero.isPrimitive( 0.0 );
* // returns true
*
* @example
* var bool = isPositiveZero.isObject( new Number( 0.0 ) );
* // returns true
*/
declare var isPositiveZero: IsPositiveZero;


// EXPORTS //

export = isPositiveZero;