Skip to content

Commit 2f1f30e

Browse files
kgrytekgryte
committed
refactor: avoid duplicate assertion logic and fix documentation errors
Ref: a4e21fb Ref: stdlib-js#1358
1 parent 0f4ebc7 commit 2f1f30e

14 files changed

Lines changed: 118 additions & 109 deletions

File tree

‎lib/node_modules/@stdlib/assert/is-positive-finite/README.md‎

Lines changed: 8 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ limitations under the License.
2020

2121
# isPositiveFinite
2222

23-
> Test if a value is a number having a non-infinite positive value.
23+
> Test if a value is a number having a finite positive value.
2424
2525
<section class="usage">
2626

@@ -32,7 +32,7 @@ var isPositiveFinite = require( '@stdlib/assert/is-positive-finite' );
3232

3333
#### isPositiveFinite( value )
3434

35-
Tests if a `value` is a `number` having a non-infinite positive value.
35+
Tests if a value is a number having a finite positive value.
3636

3737
<!-- eslint-disable no-new-wrappers -->
3838

@@ -45,13 +45,13 @@ var bool = isPositiveFinite( 5.0 );
4545
bool = isPositiveFinite( new Number( 5.0 ) );
4646
// returns true
4747

48-
bool = isPositiveFinite( 5.0/0.0 );
48+
bool = isPositiveFinite( 1.0/0.0 );
4949
// returns false
5050

5151
bool = isPositiveFinite( -5.0 );
5252
// returns false
5353

54-
bool = isPositiveFinite( new Number( 5.0/0.0 ) );
54+
bool = isPositiveFinite( new Number( 1.0/0.0 ) );
5555
// returns false
5656

5757
bool = isPositiveFinite( null );
@@ -60,7 +60,7 @@ bool = isPositiveFinite( null );
6060

6161
#### isPositiveFinite.isPrimitive( value )
6262

63-
Tests if a `value` is a primitive `number` having a non-infinite positive value.
63+
Tests if a value is a primitive number having a finite positive value.
6464

6565
<!-- eslint-disable no-new-wrappers -->
6666

@@ -79,7 +79,7 @@ bool = isPositiveFinite.isPrimitive( new Number( 3.0 ) );
7979

8080
#### isPositiveFinite.isObject( value )
8181

82-
Tests if a `value` is a `Number` object having a non-infinite positive value.
82+
Tests if a value is a `Number` object having a finite positive value.
8383

8484
<!-- eslint-disable no-new-wrappers -->
8585

@@ -92,7 +92,7 @@ var bool = isPositiveFinite.isObject( new Number( 3.0 ) );
9292
bool = isPositiveFinite.isObject( 3.0 );
9393
// returns false
9494

95-
bool = isPositiveFinite.isObject( new Number( 3.0/0.0 ) );
95+
bool = isPositiveFinite.isObject( new Number( 1.0/0.0 ) );
9696
// returns false
9797
```
9898

@@ -127,7 +127,7 @@ bool = isPositiveFinite( 0.0 );
127127
bool = isPositiveFinite( 1.0/0.0 );
128128
// returns false
129129

130-
bool = isPositiveFinite( new Number( 5.0/0.0 ) );
130+
bool = isPositiveFinite( new Number( 1.0/0.0 ) );
131131
// returns false
132132

133133
bool = isPositiveFinite( -5.0 );
@@ -148,12 +148,6 @@ bool = isPositiveFinite( null );
148148

149149
<section class="related">
150150

151-
* * *
152-
153-
## See Also
154-
155-
- <span class="package-name">[`@stdlib/assert/is-number`][@stdlib/assert/is-number]</span><span class="delimiter">: </span><span class="description">test if a value is a number.</span>
156-
157151
</section>
158152

159153
<!-- /.related -->
@@ -162,12 +156,6 @@ bool = isPositiveFinite( null );
162156

163157
<section class="links">
164158

165-
<!-- <related-links> -->
166-
167-
[@stdlib/assert/is-number]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-number
168-
169-
<!-- </related-links> -->
170-
171159
</section>
172160

173161
<!-- /.links -->

‎lib/node_modules/@stdlib/assert/is-positive-finite/benchmark/benchmark.js‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
* limitations under the License.
1717
*/
1818

19-
/* eslint-disable no-undefined, no-empty-function */
19+
/* eslint-disable no-empty-function */
2020

2121
'use strict';
2222

@@ -38,8 +38,8 @@ bench( pkg+'::primitives', function benchmark( b ) {
3838

3939
values = [
4040
'5',
41-
5.00/0.00,
42-
new Number( 5.0/0.00 ),
41+
1.0/0.0,
42+
new Number( 1.0/0.0 ),
4343
5.0,
4444
4.0,
4545
3.14,
@@ -49,7 +49,7 @@ bench( pkg+'::primitives', function benchmark( b ) {
4949
true,
5050
false,
5151
null,
52-
undefined
52+
void 0
5353
];
5454

5555
b.tic();
@@ -78,7 +78,7 @@ bench( pkg+'::objects', function benchmark( b ) {
7878
function noop() {},
7979
new Number( 2.0 ),
8080
new Number( -3.0 ),
81-
new Number( 3.14/0.00 )
81+
new Number( 3.14/0.0 )
8282
];
8383

8484
b.tic();
@@ -106,15 +106,15 @@ bench( pkg+'::primitives:isPrimitive', function benchmark( b ) {
106106
5.0,
107107
4.0,
108108
3.14,
109-
5.00/0.00,
110-
new Number( 5.0/0.00 ),
109+
1.0/0.0,
110+
new Number( 1.0/0.0 ),
111111
-5.0,
112112
-4.0,
113113
NaN,
114114
true,
115115
false,
116116
null,
117-
undefined
117+
void 0
118118
];
119119

120120
b.tic();
@@ -140,7 +140,7 @@ bench( pkg+'::objects:isPrimitive', function benchmark( b ) {
140140
values = [
141141
[],
142142
{},
143-
5.00/0.00,
143+
1.0/0.0,
144144
function noop() {},
145145
new Number( 2.0 ),
146146
new Number( -3.0 ),
@@ -170,8 +170,8 @@ bench( pkg+'::primitives:isObject', function benchmark( b ) {
170170
values = [
171171
'5',
172172
5.0,
173-
5.00/0.00,
174-
new Number( 5.0/0.00 ),
173+
1.0/0.0,
174+
new Number( 1.0/0.0 ),
175175
4.0,
176176
3.14,
177177
-5.0,
@@ -180,7 +180,7 @@ bench( pkg+'::primitives:isObject', function benchmark( b ) {
180180
true,
181181
false,
182182
null,
183-
undefined
183+
void 0
184184
];
185185

186186
b.tic();
@@ -209,7 +209,7 @@ bench( pkg+'::objects:isObject', function benchmark( b ) {
209209
function noop() {},
210210
new Number( 2.0 ),
211211
new Number( -3.0 ),
212-
new Number( 3.14/0.00 )
212+
new Number( 3.14/0.0 )
213213
];
214214

215215
b.tic();

‎lib/node_modules/@stdlib/assert/is-positive-finite/docs/repl.txt‎

Lines changed: 12 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11

22
{{alias}}( value )
3-
Tests if a value is a non-infinite positive number.
3+
Tests if a value is a positive finite number.
44

55
Parameters
66
----------
@@ -10,8 +10,7 @@
1010
Returns
1111
-------
1212
bool: boolean
13-
Boolean indicating whether value is a
14-
non-infinite positive number.
13+
Boolean indicating whether a value is a positive finite number.
1514

1615
Examples
1716
--------
@@ -23,17 +22,16 @@
2322
true
2423
> bool = {{alias}}( -5.0 )
2524
false
26-
> var bool = {{alias}}( 5.0/0.0 )
25+
> var bool = {{alias}}( 1.0/0.0 )
2726
false
28-
> bool = {{alias}}( new Number( 5.0/0.0 ) )
27+
> bool = {{alias}}( new Number( 1.0/0.0 ) )
2928
false
3029
> bool = {{alias}}( null )
3130
false
3231

3332

3433
{{alias}}.isPrimitive( value )
35-
Tests if a value is a number primitive having a
36-
non-infinite positive value.
34+
Tests if a value is a number primitive having a positive finite value.
3735

3836
Parameters
3937
----------
@@ -43,21 +41,21 @@
4341
Returns
4442
-------
4543
bool: boolean
46-
Boolean indicating if a value is a number primitive having
47-
a non-infinite positive value.
44+
Boolean indicating if a value is a number primitive having a positive
45+
finite value.
4846

4947
Examples
5048
--------
5149
> var bool = {{alias}}.isPrimitive( 3.0 )
5250
true
53-
> var bool = {{alias}}.isPrimitive( 3.0/0.0 )
51+
> var bool = {{alias}}.isPrimitive( 1.0/0.0 )
5452
false
5553
> bool = {{alias}}.isPrimitive( new Number( 3.0 ) )
5654
false
5755

5856

5957
{{alias}}.isObject( value )
60-
Tests if a value is a number object having a non-infinite positive value.
58+
Tests if a value is a number object having a positive finite value.
6159

6260
Parameters
6361
----------
@@ -67,16 +65,16 @@
6765
Returns
6866
-------
6967
bool: boolean
70-
Boolean indicating whether value is a number object
71-
having a non-infinite positive value.
68+
Boolean indicating whether value is a number object having a positive
69+
finite value.
7270

7371
Examples
7472
--------
7573
> var bool = {{alias}}.isObject( 3.0 )
7674
false
7775
> bool = {{alias}}.isObject( new Number( 3.0 ) )
7876
true
79-
> bool = {{alias}}.isObject( new Number( 3.0/0.0 ) )
77+
> bool = {{alias}}.isObject( new Number( 1.0/0.0 ) )
8078
false
8179

8280

0 commit comments

Comments
 (0)