"Then he thought within himself: "I too will try the virtue of those magical words and see if at my bidding the door will open and close." So he called out aloud, "Open, Sesame!" And no sooner had he spoken than straightway the portal flew open and he entered within."
Sesame is a library of functions for use with closures.
All functions start with an underscore, so as to not collide with already existing ColdFusion or functions that you may have written in your page or component.
It currently has 4 sections:
- Collections: for the use with arrays and structs
- Functions: for the use with other functions and closures.
- Numbers: for use with numbers and general looping
- Concurrency: To make threading operations easier
Functions that allow you manipulate and use structs and arrays much easier
collect data from one array into a whole new array. Transform closure should return the item that i to be added to the new array.
- data - the array to collect from
- transform - closure to return the item for the new array
collect data from an array or a struct into a new struct. The transform function can return either a Map, with a single key to be used as the key, and a 2nd level struct, or an array, where the 1st index in the key, and the 2nd is the value.
- data - the array / struct to collect from
- transform - the closure to create the map entry.
Take an array/struct and group the data into a grouped struct. The closure should return the key that the data should be grouped by. For arrays, this will return a struct of arrays. For structs, this will return a struct of structures.
- data - the array / struct
- grouping - the closure to return the group key.
Returns an array with all the duplicates removed (i.e. unique). For structs, this iterates through all the values, and returns an array from that, with duplicates removed.
- data - the array/struct
- comparator - optional comparator closure that takes 2 arguments for comparing of objects, and returns 0 if they are the same. If not supplied, then natural comparison will be used.
Functions that allow you to manipulate other functions / closures
Curry a function from left to right.
- func - the function/closure you want to curry
- args - the array of arguments you wish to curry with.
Functions for working with numbers and general looping
Iterates from a given number, up to a given number, using a step increment. Each number is passed through to the closure.
- numberFrom - the number to start at
- numberTo - the number to go to
- stepNumber - the step to take between iterations
- closure - the closure to call with the current count.
Executes the closure this many times, starting from zero. The current index is passed to the closure each time
- number - the number of times to execute the given closure
- closure - the closure to execute.
Iterates from this number up to the given number, inclusive, incrementing by one each time. Each number is passed through to the closure.
- numberFrom - the number to start at
- numberTo - the number to go to
- closure - the closure to call with the current count.
Functions for working with threads and concurrent programming
Do each iteration in it's own thread, and then join it all back again at the end.
- data - the array/struct to perform a closure on
- closure - the closure to pass through the elements from data to.
Please feel free to fork this project and contribute.
Do note that the readme is generated by the generate.cfm
file, which creates the documentation from the function hint meta data.
So if your functions are properly commented, the documentation can be updated automatically.
Therefore, if you want to contribute to the documentation, please do so in the relevent functions comments, so that it ends up in the README.md on regeneration.
Thanks!!!