Interface IZSorter

Represents a sorter algorithm that can help with building sorts based on common techniques.

interface IZSorter {
    index(subject?: string): number;
    sort(subject?: string): IZSort[];
    sorted(subject?: string): ZSortDirection | undefined;
}

Implemented by

ZSorterSingle

Index

Methods

index sort sorted

Methods

index

index(subject?: string): number
Gets the current sort index for the subject or -1 if it is not sorted.

This should be 1 based.
Parameters
- Optionalsubject: string
  The subject to sort. If this is undefined, the subject should be considered the empty string (the object itself).
Returns number
The current sort index.
- Defined in packages/helpful-query/src/sort/sorter.mts:19

sort

sort(subject?: string): IZSort[]
Sorts a specific subject.
Parameters
- Optionalsubject: string
  The subject to sort. Undefined is considered the empty string.
Returns IZSort[]
The updated sort list.
- Defined in packages/helpful-query/src/sort/sorter.mts:40

sorted

sorted(subject?: string): ZSortDirection | undefined
Gets the current direction that the subject is sorted.
Parameters
- Optionalsubject: string
  The subject to check. Undefined is considered the empty string (the object itself).
Returns ZSortDirection | undefined
- Defined in packages/helpful-query/src/sort/sorter.mts:28