closestTo

Finds the date closest to a target within an iterable of TheDate or SerializedTheDate. In case of equality, an optional tieBreaker lets you favor the past or the future.

Interactive example

Syntax

interface ClosestToParams {
	tieBreaker?: "favorPast" | "favorFuture";
}

Classic signature

function closestTo<
	GenericIterable extends Iterable<TheDate | SerializedTheDate>
>(
	target: TheDate | SerializedTheDate,
	params?: ClosestToParams
): (input: GenericIterable) => TheDate | undefined

Curried signature

function closestTo<
	GenericIterable extends Iterable<TheDate | SerializedTheDate>
>(
	input: GenericIterable,
	target: TheDate | SerializedTheDate,
	params?: ClosestToParams
): TheDate | undefined

Parameters

• target: Target date (TheDate or SerializedTheDate).
• input: Iterable of TheDate or SerializedTheDate.
• tieBreaker: (Optional) Handles ties (favorPast by default).

Return value

The closest TheDate, or undefined if the iterable is empty.

See also

• each
• round