createSortByBooleanFn

Creates a sort function for objects by a boolean property.

Values are coerced with Boolean() before comparing, so null, undefined, 0, and '' behave as false, and any other truthy value behaves as true.

Available since v3.0.0

Import

import { createSortByBooleanFn } from '@helpers4/array';
// or, from the all-in-one package (same code, one install):
import { createSortByBooleanFn } from 'helpers4/array';

Signature

createSortByBooleanFn<T extends object>(property: keyof T, trueFirst: boolean): SortFn<T>

Parameters

Parameter	Type	Description
`property`	`keyof T`	The property to sort by.
`trueFirst`	`boolean`	Whether `true` values sort before `false` values (default: `true`).

Returns

SortFn<T> — Sort function

Examples

Sort objects with true values first

Default items float to the top of the list.

const items = [{ isDefault: false }, { isDefault: true }, { isDefault: false }];
items.sort(createSortByBooleanFn('isDefault'))
// => [{ isDefault: true }, { isDefault: false }, { isDefault: false }]

Sort with false values first

Pass trueFirst = false to invert the priority.

const items = [{ archived: true }, { archived: false }];
items.sort(createSortByBooleanFn('archived', false))
// => [{ archived: false }, { archived: true }]

`SortFn`

Sort function type for arrays

type SortFn<T> = (a: T, b: T) => number

Source

View source on GitHub