Tour API Demos Download Tests
Aperture version 1.0
Generated by: JsDoc Toolkit 2.4.0

Namespace aperture.filter

Aperture filter APIs

Namespace Summary
Constructor Attributes Constructor Name and Description
 

Method Summary

Namespace Detail

aperture.filter
Parameters:
namespace

Method Detail

  • <static> aperture.filter.conditional(checkFunction, filterFunction)
    Takes a conditional function and a effect function and returns a function that will apply the given effect to the supplied arguments only when the truth function returns a truthy value when called with the supplied arguments. For example: var makeBigBigger = conditional( function(value) { return value > 1000; }, aperture.filter.scale( 2 ) ); var makeRedBlue = conditional( function(value) { return value === 'red'; }, function() { return 'blue'; } );
    Parameters:
    {Function} checkFunction
    {Function} filterFunction
  • <static> aperture.filter.constant(value)
    Returns a function that always returns the supplied constant value
    Parameters:
    value
  • <static> aperture.filter.scale(amount)
    Returns a effect function that scales a provided number by the given scalar value.
    Parameters:
    amount
  • <static> aperture.filter.shift(amount)
    Returns a effect function that shifts a provided number by the given scalar value.
    Parameters:
    amount