Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/stdlib-js/assert-is-between

Test if a value is between two values.
https://github.com/stdlib-js/assert-is-between

assert assertion between btwn closed compare comparison interval javascript node node-js nodejs open order range stdlib util utilities utility utils

Last synced: 3 months ago
JSON representation

Test if a value is between two values.

Awesome Lists containing this project

README 

        



  

    About stdlib...

  

  
We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.


  
The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.


  
When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.


  
To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!



# isBetween



[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] 



> Test if a value is between two values.



## Installation



```bash

npm install @stdlib/assert-is-between

```



Alternatively,



-   To load the package in a website via a `script` tag without installation and bundlers, use the [ES Module][es-module] available on the [`esm`][esm-url] branch (see [README][esm-readme]).

-   If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions).

-   For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd`][umd-url] branch (see [README][umd-readme]).



The [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships.



To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.



## Usage



```javascript

var isBetween = require( '@stdlib/assert-is-between' );

```



#### isBetween( value, a, b\[, left, right] )



Tests if a `value` is between two values `a` (left comparison value) and `b` (right comparison value).



```javascript

var bool = isBetween( 4, 3, 5 );

// returns true



bool = isBetween( 2, 3, 5 );

// returns false



bool = isBetween( 6, 3, 5 );

// returns false

```



By default, the function assumes that `a` and `b` are inclusive.



```javascript

var bool = isBetween( 3, 3, 5 );

// returns true



bool = isBetween( 3, 3, 5, 'closed', 'closed' );

// returns true



bool = isBetween( 5, 3, 5 );

// returns true



bool = isBetween( 5, 3, 5, 'closed', 'closed' );

// returns true

```



To make `a` and/or `b` exclusive, set the respective arguments to `'open'`.



```javascript

var bool = isBetween( 3, 3, 5, 'open', 'closed' );

// returns false



bool = isBetween( 5, 3, 5, 'closed', 'open' );

// returns false

```



## Notes



-   If `a` and `b` are inclusive, the comparison is equivalent to



    ```text

    a <= v <= b

    ```



-   If `a` is exclusive and `b` is inclusive, the comparison is equivalent to



    ```text

    a < v <= b

    ```



-   If `a` is inclusive and `b` is exclusive, the comparison is equivalent to



    ```text

    a <= v < b

    ```



-   If `a` and `b` are exclusive, the comparison is equivalent to



    ```text

    a < v < b

    ```



-   If provided non-numeric values, comparisons are performed according to lexicographic order.



## Examples



```javascript

var randu = require( '@stdlib/random-base-randu' );

var round = require( '@stdlib/math-base-special-round' );

var isBetween = require( '@stdlib/assert-is-between' );



var bool;

var a;

var b;

var v;

var i;



for ( i = 0; i < 100; i++ ) {

    a = round( (randu()*10.0) + 5.0 );

    b = round( (randu()*10.0) + 15.0 );

    v = round( randu()*25.0 );

    bool = isBetween( v, a, b, 'open', 'closed' );

    console.log( '%d < %d <= %d: %s', a, v, b, bool.toString() );

}

```



* * *



## See Also



-   [`@stdlib/assert-is-between-array`][@stdlib/assert/is-between-array]: test if a value is an array-like object where every element is between two values.



* * *



## Notice



This package is part of [stdlib][stdlib], a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.



For more information on the project, filing bug reports and feature requests, and guidance on how to develop [stdlib][stdlib], see the main project [repository][stdlib].



#### Community



[![Chat][chat-image]][chat-url]



---



## License



See [LICENSE][stdlib-license].



## Copyright



Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors].



[npm-image]: http://img.shields.io/npm/v/@stdlib/assert-is-between.svg

[npm-url]: https://npmjs.org/package/@stdlib/assert-is-between



[test-image]: https://github.com/stdlib-js/assert-is-between/actions/workflows/test.yml/badge.svg?branch=main

[test-url]: https://github.com/stdlib-js/assert-is-between/actions/workflows/test.yml?query=branch:main



[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/assert-is-between/main.svg

[coverage-url]: https://codecov.io/github/stdlib-js/assert-is-between?branch=main



[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg

[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im



[stdlib]: https://github.com/stdlib-js/stdlib



[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors



[umd]: https://github.com/umdjs/umd

[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules



[deno-url]: https://github.com/stdlib-js/assert-is-between/tree/deno

[deno-readme]: https://github.com/stdlib-js/assert-is-between/blob/deno/README.md

[umd-url]: https://github.com/stdlib-js/assert-is-between/tree/umd

[umd-readme]: https://github.com/stdlib-js/assert-is-between/blob/umd/README.md

[esm-url]: https://github.com/stdlib-js/assert-is-between/tree/esm

[esm-readme]: https://github.com/stdlib-js/assert-is-between/blob/esm/README.md

[branches-url]: https://github.com/stdlib-js/assert-is-between/blob/main/branches.md



[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/assert-is-between/main/LICENSE



[@stdlib/assert/is-between-array]: https://github.com/stdlib-js/assert-is-between-array