subtractYears

Subtracts a positive number of years from a TheDate.

Interactive example

Syntax

Classic signature

function subtractYears<
	GenericInput extends TheDate, 
	GenericYear extends number
>(
	input: GenericInput,
	year: PositiveNumber<GenericYear>
): TheDate

Curried signature

function subtractYears<
	GenericInput extends TheDate, 
	GenericYear extends number
>(
	year: PositiveNumber<GenericYear>
): (input: GenericInput) => TheDate

Parameters

• year: Number of years to subtract.
• input: Original date.

Return value

A TheDate moved back by the given number of years.

See also

• addYears
• subtractMonths