ArrayPeer Static Constructor

Searches an array using simple or complex conditions.

The conditons are evaluated and compared strictly equal and the item must match all conditions to be in the returned array.

Conditions with Class, Function or RegExp as the expected values are subject to some additional rules regarding matches.

Class

If the actual value is a Class then they are compared with ===, else the actual value will be checked to see if it is of the Class type.

Function

If the actual value is a Function then they are compared with ===, else the expected function is called with the item and the actual value as parameters. This function needs to return a Boolean. eg var condtions:Object = { someProperty: function(item: actual::Boolean { return actual != null; } }

RegExp

If the actual value is a RegExp then they are compared with ===, else the actual value is tested with the RegExp.

All other expected value are compared with ===

   var movies:Array = []; // retrieve from some datasource
   // find with simple property value condition
   var moviesByMichaelBay:Array = ArrayPeer.find( movies, { director: 'Michael Bay' } );
   // find with property chain condition (assuming the 'released' property returns a Date instance)
   var moviesByMichaelByReleasedIn2007:Array = ArrayPeer.find( moviesByMichaelBay, { 'released.fullYear': 2007 }
   // find with Class condition
   // todo: add example
   // find with Function condition
   var moviesWithAverageRatings:Array = ArrayPeer.find( movies, { rating: function(item:Movie, actual:Number):Boolean { return actual > 2.4 && actual < 3.7; } })
   // find with RegExp
   var moviesTheBeginWithTr:Array = ArrayPeer.find( movies, { name: new RegExp('^Tr.) });
   // find with sub-array query (assuming the 'cast' property returns an Array of Actors with the property 'name')
   var moviesWithMeganFox:Array = ArrayPeer.find( movies, { 'cast.name': 'Megan Fox' })
   

Shortcut for searching by a single property

Shortcut for searching by a single property

Shortcut for retrieving the first matching item

Shortcut for retrieving the last matching item