Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "assert/is-between-array/docs/types/index.d"

Index

Type aliases

Functions

Type aliases

Comparison

Comparison: "open" | "closed"

Comparison type.

Functions

Export assignment isBetweenArray

  • Tests if a value is an array-like object where every element is between two values.

    Parameters

    • value: any

      value to test

    • a: any

      left comparison value

    • b: any

      right comparison value

    • Optional left: Comparison

      indicates whether the left comparison value is inclusive (default: 'closed')

    • Optional right: Comparison

      indicates whether the right comparison value is inclusive (default: 'closed')

    Returns boolean

    boolean indicating whether a value is an array-like object where every element is between two values

    Example

    var arr = [ 3.0, 3.14, 4.0 ];
    var bool = isBetweenArray( arr, 3.0, 4.0 );
    // returns true

    Example

    var arr = [ 3.0, 3.14, 4.0 ];
    var bool = isBetweenArray( arr, 3.14, 4.0 );
    // returns false

    Example

    var arr = [ 3.0, 3.14, 4.0 ];
    var bool = isBetweenArray( arr, 3.0, 3.14 );
    // returns false

    Example

    var arr = [ 3.0, 3.14, 4.0 ];
    var bool = isBetweenArray( arr, 3.0, 4.0, 'open', 'closed' );
    // returns false

    Example

    var arr = [ 3.0, 3.14, 4.0 ];
    var bool = isBetweenArray( arr, 3.0, 4.0, 'closed', 'open' );
    // returns false