Skip to content

subtractYears

Subtracts a number of years from a TheDate.

Interactive example

Syntax

Classic signature

typescript
function subtractYears<
	GenericInput extends TheDate | SerializedTheDate, 
	GenericYear extends number
>(
	input: GenericInput,
	year: GenericYear
): TheDate

Curried signature

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

Parameters

  • year: Number of years to subtract.
  • input: TheDate or SerializedTheDate.

Return value

A TheDate moved back by the given number of years.

See also

Released under the MIT license.