Function ArrayMonotonic

Checks if the given value is an array sorted in either (strictly) ascending or (strictly) descending order.

This validator will always pass if the given value is an empty array.

Example

// Ensure the array is sorted in reverse order of dates of birth.
@ArrayMonotonic<User>({
    monotonicity: Monotonicity.WEAKLY_DECREASING,
    projection: user => user.dateOfBirth.getTime()
})
users: User[]
Copy

// Ensure the array is sorted in ascending order, allowing duplicates.
@ArrayMonotonic({
    monotonicity: Monotonicity.WEAKLY_INCREASING
})
numbers: number[]

// Ensure the array is sorted by user id in descending order, allowing no duplicates.
@ArrayMonotonic<User>({
    monotonicity: Monotonicity.STRICTLY_DECREASING,
    projection: user => user.id
})
users: User[]

// Same as above, but using a comparator.
@ArrayMonotonic<User>({
    monotonicity: Monotonicity.STRICTLY_DECREASING,
    comparator: (a, b) => b.id - a.id
})
users: User[]
Copy