Sort

2026-06-14T16:43:37Z

PureFox48: Removed signature from last edit.

<c>sort</c> sorts a list in place. With null or no argument, this sorts the list elements by their own values.

See also: [[shuffle]]

=== Arguments ===

{| class="wikitable"
|-
! Parameter Name !! Default Value !! Meaning
|-
| ''self'' || list || list to sort
|-
| ''byKey'' || optional || if given, sort each element by indexing with this key.
|-
| ''ascending'' || number, default = 1 || pass 0 or false to sort in descending order.
|}

=== Usage Notes ===
With the byKey argument, each
element is indexed by that argument, and the elements are sorted
by the result. (This only works if the list elements are maps, or
they are lists and byKey is an integer index.)

== Example ==

Sorting numeric list in-place:

<ms>
a = [5,3,4,1,2]
a.sort // results in a == [1, 2, 3, 4, 5]</ms>

Sorting in reverse order:

<ms>
b = [1,3,0,8,7]
b.sort(null, false) // results in b == [8, 7, 3, 1, 0]</ms>

Sorting objects / maps by some property:

<ms>
// Let's consider people
Person = {}

newPerson = function(name, age)
p = new Person
p.name = name
p.age = age
return p
end function

john = newPerson("John", 30)
ursula = newPerson("Ursula", 20)
anna = newPerson("Anna", 40)

people = [john, ursula, anna]

people.sort "age" // results in people == [ursula, john, anna]
people.sort "name" // results in people == [anna, john, ursula]
</ms>

[[Category:Intrinsic Functions]]
[[Category:List Methods]]

Sort

2026-06-14T13:35:13Z

PureFox48: Added documentation for 'ascending' parameter and an example of sorting in descending order.

MiniScript Wiki - User contributions [en]

Sort

Sort