time-to-botec/js/node_modules/@stdlib/assert/is-positive-integer/README.md
NunoSempere b6addc7f05 feat: add the node modules
Necessary in order to clearly see the squiggle hotwiring.
2022-12-03 12:44:49 +00:00

140 lines
2.8 KiB
Markdown

<!--
@license Apache-2.0
Copyright (c) 2018 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.
-->
# isPositiveInteger
> Test if a value is a number having a positive integer value.
<section class="usage">
## Usage
```javascript
var isPositiveInteger = require( '@stdlib/assert/is-positive-integer' );
```
#### isPositiveInteger( value )
Tests if a `value` is a `number` having a positive `integer` value.
<!-- eslint-disable no-new-wrappers -->
```javascript
var Number = require( '@stdlib/number/ctor' );
var bool = isPositiveInteger( 5.0 );
// returns true
bool = isPositiveInteger( new Number( 5.0 ) );
// returns true
bool = isPositiveInteger( -5.0 );
// returns false
bool = isPositiveInteger( 0.0 );
// returns false
bool = isPositiveInteger( 3.14 );
// returns false
bool = isPositiveInteger( null );
// returns false
```
#### isPositiveInteger.isPrimitive( value )
Tests if a `value` is a primitive `number` having a positive `integer` value.
<!-- eslint-disable no-new-wrappers -->
```javascript
var Number = require( '@stdlib/number/ctor' );
var bool = isPositiveInteger.isPrimitive( 3.0 );
// returns true
bool = isPositiveInteger.isPrimitive( new Number( 3.0 ) );
// returns false
```
#### isPositiveInteger.isObject( value )
Tests if a `value` is a `Number` object having a positive `integer` value.
<!-- eslint-disable no-new-wrappers -->
```javascript
var Number = require( '@stdlib/number/ctor' );
var bool = isPositiveInteger.isObject( 3.0 );
// returns false
bool = isPositiveInteger.isObject( new Number( 3.0 ) );
// returns true
```
</section>
<!-- /.usage -->
<section class="examples">
## Examples
<!-- eslint-disable no-new-wrappers -->
<!-- eslint no-undef: "error" -->
```javascript
var Number = require( '@stdlib/number/ctor' );
var isPositiveInteger = require( '@stdlib/assert/is-positive-integer' );
var bool = isPositiveInteger( 5.0 );
// returns true
bool = isPositiveInteger( new Number( 5.0 ) );
// returns true
bool = isPositiveInteger( 0.0 );
// returns false
bool = isPositiveInteger( 3.14 );
// returns false
bool = isPositiveInteger( -5.0 );
// returns false
bool = isPositiveInteger( '5' );
// returns false
bool = isPositiveInteger( null );
// returns false
```
</section>
<!-- /.examples -->
<section class="links">
</section>
<!-- /.links -->