Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "utils/find/docs/types/index.d"

Index

Type aliases

Binary

Binary<T>: (value: T, index: number) => boolean

Checks whether an element in a collection passes a test.

param

collection value

param

collection index

returns

boolean indicating whether an element in a collection passes a test

Type parameters

  • T

Type declaration

    • (value: T, index: number): boolean
    • Parameters

      • value: T
      • index: number

      Returns boolean

Callback

Callback<T>: Nullary | Unary<T> | Binary<T> | Ternary<T>

Checks whether an element in a collection passes a test.

param

collection value

param

collection index

param

input collection

returns

boolean indicating whether an element in a collection passes a test

Type parameters

  • T

Nullary

Nullary: () => boolean

Checks whether an element in a collection passes a test.

returns

boolean indicating whether an element in a collection passes a test

Type declaration

    • (): boolean
    • Returns boolean

Ternary

Ternary<T>: (value: T, index: number, collection: Collection<T>) => boolean

Checks whether an element in a collection passes a test.

param

collection value

param

collection index

param

input collection

returns

boolean indicating whether an element in a collection passes a test

Type parameters

  • T

Type declaration

    • (value: T, index: number, collection: Collection<T>): boolean
    • Parameters

      • value: T
      • index: number
      • collection: Collection<T>

      Returns boolean

Unary

Unary<T>: (value: T) => boolean

Checks whether an element in a collection passes a test.

param

collection value

returns

boolean indicating whether an element in a collection passes a test

Type parameters

  • T

Type declaration

    • (value: T): boolean
    • Parameters

      • value: T

      Returns boolean

Functions

Export assignment find

  • Finds elements in an array-like object that satisfy a test condition.

    Type parameters

    • T

    Parameters

    • arr: Collection<T> | string

      object from which elements will be tested

    • clbk: Callback<T>

      function invoked for each array element. If the return value is truthy, the value is considered to have satisfied the test condition.

    Returns Array < number >

    array of indices

    Example

    function condition( val ) {
        return val > 20;
    }
    
    var data = [ 30, 20, 50, 60, 10 ];
    var vals = find( data, condition );
    // returns [ 0, 2, 3 ]

    Example

    function condition( val ) {
        return val > 1000;
    }
    
    var data = [ 30, 20, 50, 60, 10 ];
    var vals = find( data, condition );
    // returns []
  • Finds elements in an array-like object that satisfy a test condition.

    Type parameters

    • T

    Parameters

    • arr: Collection<T> | string

      object from which elements will be tested

    • options: IndicesOptions | BaseOptions

      function options

    • clbk: Callback<T>

      function invoked for each array element. If the return value is truthy, the value is considered to have satisfied the test condition.

    Returns Array < number >

    array of indices

    Example

    function condition( val ) {
        return val > 20;
    }
    
    var data = [ 30, 20, 50, 60, 10 ];
    var opts = {
        'k': 2,
        'returns': 'indices'
    };
    var vals = find( data, opts, condition );
    // returns [ 0, 2 ]

    Example

    function condition( val ) {
        return val > 20;
    }
    
    var data = [ 30, 20, 50, 60, 10 ];
    var opts = {
        'k': -2,
        'returns': 'indices'
    };
    var vals = find( data, opts, condition );
    // returns [ 3, 2 ]
  • Finds elements in an array-like object that satisfy a test condition.

    Type parameters

    • T

    Parameters

    • arr: Collection<T> | string

      object from which elements will be tested

    • options: ValuesOptions

      function options

    • clbk: Callback<T>

      function invoked for each array element. If the return value is truthy, the value is considered to have satisfied the test condition.

    Returns Array < T >

    array of values

    Example

    function condition( val ) {
        return val > 20;
    }
    
    var data = [ 30, 20, 50, 60, 10 ];
    var opts = {
        'k': 2,
        'returns': 'values'
    };
    var vals = find( data, opts, condition );
    // returns [ 30, 50 ]

    Example

    function condition( val ) {
        return val > 20;
    }
    
    var data = [ 30, 20, 50, 60, 10 ];
    var opts = {
        'k': -2,
        'returns': 'values'
    };
    var vals = find( data, opts, condition );
    // returns [ 60, 50 ]
  • Finds elements in an array-like object that satisfy a test condition.

    Type parameters

    • T

    Parameters

    • arr: Collection<T> | string

      object from which elements will be tested

    • options: IndicesAndValuesOptions

      function options

    • clbk: Callback<T>

      function invoked for each array element. If the return value is truthy, the value is considered to have satisfied the test condition.

    Returns Array < [ ] >

    array of index-value pairs

    Example

    function condition( val ) {
        return val > 20;
    }
    
    var data = [ 30, 20, 50, 60, 10 ];
    var opts = {
        'k': -2,
        'returns': '*'
    };
    var vals = find( data, opts, condition );
    // returns [ [3, 60], [2, 50] ]