Function naturalSort

Sort an array in-place using a language-aware comparison function that can sort by a property key. If no property key is provided, the array is sorted directly.

  • naturalSort<T>(
        arr: T[],
        propertyKey?: string,
        sortOptions?: { ignorePunctuation: boolean; numeric: boolean },
    ): T[]

  • Type Parameters

    • T

    Parameters

    • arr: T[]

      The array to sort

    • OptionalpropertyKey: string = ""

      The property key to sort by, if any; can be a dot-separated path

    • OptionalsortOptions: { ignorePunctuation: boolean; numeric: boolean } = {}

      Options affecting the sorting of elements

      • ignorePunctuation: boolean

        Whether punctuation should be ignored.

      • numeric: boolean

        Whether numeric collation should be used, such that "1" < "2" < "10".

    Returns T[]

    The sorted array

Settings

Member Visibility