Class SortingHelpers

Static performIntegerSort

• performIntegerSort(source, options?): any[]

• Given a source object to sort, a target to sort relative to, and an Array of siblings in the container: Determine the updated sort keys for the source object, or all siblings if a reindex is required. Return an Array of updates to perform, it is up to the caller to dispatch these updates. Each update is structured as: { target: object, update: {sortKey: sortValue} }

  Parameters

  • source: any

    The source object being sorted
  • Optional options: {
        target: any;
        siblings: any[];
        sortKey: string;
        sortBefore: boolean;
    } = {}

    Options which modify the sort behavior

    • target: any

      The target object relative which to sort

    • siblings: any[]

      The Array of siblings which the source should be sorted within

    • sortKey: string

      The property name within the source object which defines the sort key

    • sortBefore: boolean

      Explicitly sort before (true) or sort after( false). If undefined the sort order will be automatically determined.

  Returns any[]

  An Array of updates for the caller of the helper function to perform