Skip to content

Commit

Permalink
Auto-generated commit
Browse files Browse the repository at this point in the history
  • Loading branch information
stdlib-bot committed Feb 23, 2024
1 parent 9234264 commit 10cb9db
Show file tree
Hide file tree
Showing 18 changed files with 1,327 additions and 4 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/npm_downloads.yml
Original file line number Diff line number Diff line change
Expand Up @@ -86,8 +86,8 @@ jobs:
# Upload the download data:
- name: 'Upload data'
# Pin action to full length commit SHA corresponding to v3.1.3
uses: actions/upload-artifact@a8a3f3ad30e3422c9c7b888a15615d19a852ae32
# Pin action to full length commit SHA
uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1
with:
# Define a name for the uploaded artifact (ensuring a unique name for each job):
name: npm_downloads
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/test_bundles.yml
Original file line number Diff line number Diff line change
Expand Up @@ -168,8 +168,8 @@ jobs:

# Install Deno:
- name: 'Install Deno'
# Pin action to full length commit SHA corresponding to v1.1.2
uses: denoland/setup-deno@61fe2df320078202e33d7d5ad347e7dcfa0e8f31
# Pin action to full length commit SHA
uses: denoland/setup-deno@041b854f97b325bd60e53e9dc2de9cb9f9ac0cba # v1.1.4
with:
deno-version: vx.x.x

Expand Down
1 change: 1 addition & 0 deletions CONTRIBUTORS
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ Joey Reed <[email protected]>
Jordan Gallivan <[email protected]>
Joris Labie <[email protected]>
Justin Dennison <[email protected]>
Karthik Prakash <[email protected]>
Marcus Fantham <[email protected]>
Matt Cochrane <[email protected]>
Milan Raj <[email protected]>
Expand Down
163 changes: 163 additions & 0 deletions is-nonnegative-finite/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,163 @@
<!--
@license Apache-2.0
Copyright (c) 2024 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.
-->

# isNonNegativeFinite

> Test if a value is a number having a nonnegative finite value.
<section class="usage">

## Usage

```javascript
var isNonNegativeFinite = require( '@stdlib/assert/is-nonnegative-finite' );
```

#### isNonNegativeFinite( value )

Tests if a `value` is a `number` having a nonnegative finite value.

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

```javascript
var Number = require( '@stdlib/number/ctor' );

var bool = isNonNegativeFinite( 5.0 );
// returns true

bool = isNonNegativeFinite( new Number( 5.0 ) );
// returns true

bool = isNonNegativeFinite( 3.14 );
// returns true

bool = isNonNegativeFinite( -5.0 );
// returns false

bool = isNonNegativeFinite( null );
// returns false

bool = isNonNegativeFinite( Infinity );
// returns false
```

#### isNonNegativeFinite.isPrimitive( value )

Tests if a `value` is a primitive `number` having a nonnegative finite value.

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

```javascript
var Number = require( '@stdlib/number/ctor' );

var bool = isNonNegativeFinite.isPrimitive( 3.0 );
// returns true

bool = isNonNegativeFinite.isPrimitive( new Number( 3.0 ) );
// returns false
```

#### isNonNegativeFinite.isObject( value )

Tests if a `value` is a `Number` object having a nonnegative finite value.

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

```javascript
var Number = require( '@stdlib/number/ctor' );

var bool = isNonNegativeFinite.isObject( 3.0 );
// returns false

bool = isNonNegativeFinite.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 isNonNegativeFinite = require( '@stdlib/assert/is-nonnegative-finite' );

var bool = isNonNegativeFinite( 5.0 );
// returns true

bool = isNonNegativeFinite( new Number( 5.0 ) );
// returns true

bool = isNonNegativeFinite( 0.0 );
// returns true

bool = isNonNegativeFinite( 3.14 );
// returns true

bool = isNonNegativeFinite( -5.0 );
// returns false

bool = isNonNegativeFinite( '5' );
// returns false

bool = isNonNegativeFinite( null );
// returns false
```

</section>

<!-- /.examples -->

<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->

<section class="related">

* * *

## See Also

- <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>
- <span class="package-name">[`@stdlib/assert/is-finite`][@stdlib/assert/is-finite]</span><span class="delimiter">: </span><span class="description">test if a value is a finite number.</span>

</section>

<!-- /.related -->

<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->

<section class="links">

<!-- <related-links> -->

[@stdlib/assert/is-number]: https://github.com/stdlib-js/assert/tree/main/is-number
[@stdlib/assert/is-finite]: https://github.com/stdlib-js/assert/tree/main/is-finite

<!-- </related-links> -->

</section>

<!-- /.links -->
Loading

0 comments on commit 10cb9db

Please sign in to comment.