functions.js
Utilities for creating functions. Loosely inspired by the java classes: http://go/functions.java and http://go/predicate.java.

File Location

functions/functions.js

Public Protected Private

Global Functions

goog.functions.FALSE()
Always returns false.
code »
goog.functions.NULL()
Always returns NULL.
code »
goog.functions.TRUE()
Always returns true.
code »
goog.functions.and(var_args) ⇒
Function
Creates a function that returns true if each of its components evaluates to true. The components are evaluated in order, and the evaluation will be short-circuited as soon as a function returns false. For example, (goog.functions.and(f, g))(x) is equivalent to f(x) && g(x).
Arguments:
var_args :
(Function | null | undefined)
A list of functions.
Returns: 
Function
  A function that ANDs its component functions.
code »
goog.functions.compose(var_args) ⇒
Function
Creates the composition of the functions passed in. For example, (goog.functions.compose(f, g))(a) is equivalent to f(g(a)).
Arguments:
var_args :
(Function | null | undefined)
A list of functions.
Returns: 
Function
  The composition of all inputs.
code »
goog.functions.constant(retValue) ⇒
Function
Creates a function that always returns the same value.
Arguments:
retValue :
*
The value to return.
Returns: 
Function
  The new function.
code »
goog.functions.create(constructor, var_args) ⇒
Object
Generic factory function to construct an object given the constructor and the arguments. Intended to be bound to create object factories. Callers should cast the result to the appropriate type for proper type checking by the compiler.
Arguments:
constructor :
Function
The constructor for the Object.
var_args :
*
The arguments to be passed to the constructor.
Returns: 
Object
  A new instance of the class given in constructor.
code »
goog.functions.error(message) ⇒
Function
Creates a function that always throws an error with the given message.
Arguments:
message :
string
The error message.
Returns: 
Function
  The error-throwing function.
code »
goog.functions.identity(opt_returnValue, var_args) ⇒
*
A simple function that returns the first argument of whatever is passed into it.
Arguments:
opt_returnValue :
*
The single value that will be returned.
var_args :
*
Optional trailing arguments. These are ignored.
Returns: 
*
  The first argument passed in, or undefined if nothing was passed.
code »
goog.functions.lock(f) ⇒
Function
Given a function, create a function that silently discards all additional arguments.
Arguments:
f :
(Function | null)
The original function.
Returns: 
Function
  A version of f that discards its arguments.
code »
goog.functions.not(f) ⇒
Function
Creates a function that returns the Boolean opposite of a provided function. For example, (goog.functions.not(f))(x) is equivalent to !f(x).
Arguments:
f :
Function
The original function.
Returns: 
Function
  A function that delegates to f and returns opposite.
code »
goog.functions.or(var_args) ⇒
Function
Creates a function that returns true if any of its components evaluates to true. The components are evaluated in order, and the evaluation will be short-circuited as soon as a function returns true. For example, (goog.functions.or(f, g))(x) is equivalent to f(x) || g(x).
Arguments:
var_args :
(Function | null | undefined)
A list of functions.
Returns: 
Function
  A function that ORs its component functions.
code »
goog.functions.sequence(var_args) ⇒
Function
Creates a function that calls the functions passed in in sequence, and returns the value of the last function. For example, (goog.functions.sequence(f, g))(x) is equivalent to f(x),g(x).
Arguments:
var_args :
(Function | null | undefined)
A list of functions.
Returns: 
Function
  A function that calls all inputs in sequence.
code »
goog.functions.withReturnValue(f, retValue) ⇒
Function
Given a function, create a new function that swallows its return value and replaces it with a new one.
Arguments:
f :
(Function | null)
A function.
retValue :
*
A new return value.
Returns: 
Function
  A new function.
code »

Directory functions

File Reference