ArraySort

Sorts array elements numerically or alphanumerically.

ArraySort( array, sorttype_or_closure [, sort_order [, locale_sensitive ] ] )

Returns: Boolean

Argument Description Default
array
object, required

Name of an array

sorttype_or_closure
object, required

value can be a string or a closure/function.

a string must be one of the following values:

  • "numeric": sorts numbers
  • "text": sorts text alphabetically, taking case into account (case sensitive)
  • "textnocase": sorts text alphabetically, without regard to case (case insensitive)

if you define a closure/function, the closure/function must accept 2 parameters of any type and return: -1, if first parameter is "smaller" than second parameter 0, if first parameter is equal to second parameter 1, first parameter is "bigger" than second parameter

Alias: sort_type, sortType, closure, function, udf

sort_order
string, optional

sort direction:

  • asc(default): ascending sort order
  • desc: descending sort order.

Alias: sortOrder

asc

locale_sensitive
boolean, optional

if true it does a locale sensitive sorting.

Alias: localeSensitive

false

Examples

Simple array using sort type and order

SomeArray = ["COLDFUSION","coldfusion","adobe","LucEE","LUCEE"];
arraySort(SomeArray,"text","desc");
dump(SomeArray);
//member function
SomeArray.sort("text","desc");
dump(SomeArray);
SomeArray = [
    {name="testemployee", age="32"},
    {name="employeetest", age="36"}
];
arraySort(
    SomeArray,
    function (e1, e2){
        return compare(e1.name, e2.name);
    }
);
dump(SomeArray);
// member function with closure
SomeArray.sort(
    function (e1, e2){
        return compare(e1.name, e2.name);
    }
);
dump(SomeArray);

See also