Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "utils/async/if-else/docs/types/index.d"

Index

Type aliases

Callback

Callback: (error: Error | null, result: any) => void

Callback function.

param

encountered error or null

param

x or y

Type declaration

    • (error: Error | null, result: any): void
    • Parameters

      • error: Error | null
      • result: any

      Returns void

Predicate

Predicate: (clbk: PredicateCallback) => void

Predicate function.

param

callback to invoke upon predicate function completion

Type declaration

PredicateBinary

PredicateBinary: (error: Error, bool: boolean) => void

Predicate callback function.

param

error object

param

condition used to determine whether to invoke callback with x or y

Type declaration

    • (error: Error, bool: boolean): void
    • Parameters

      • error: Error
      • bool: boolean

      Returns void

PredicateCallback

Predicate callback function.

param

error object

param

condition used to determine whether to invoke callback with x or y

PredicateNullary

PredicateNullary: () => void

Predicate callback function.

Type declaration

    • (): void
    • Returns void

PredicateUnary

PredicateUnary: (error: Error) => void

Predicate callback function.

param

error object

Type declaration

    • (error: Error): void
    • Parameters

      • error: Error

      Returns void

Functions

Export assignment ifelseAsync

  • If a predicate function returns a truthy value, returns x; otherwise, returns y.

    Parameters

    • predicate: Predicate

      predicate function

    • x: any

      value to return if a condition is truthy

    • y: any

      value to return if a condition is falsy

    • done: Callback

      callback to invoke upon completion

    Returns void

    Example

    var randu = require( `@stdlib/random/base/randu` );
    
    function predicate( clbk ) {
        setTimeout( onTimeout, 0 );
        function onTimeout() {
            clbk( null, randu() > 0.5 );
        }
    }
    
    function done( error, result ) {
        if ( error ) {
            throw error;
        }
        console.log( result );
    }
    ifelseAsync( predicate, 1.0, -1.0, done );