Function startOfYear

startOfYear<DateType extends Date, ResultDate extends Date = DateType>(
date: DateArg<DateType>,
options?: StartOfYearOptions<ResultDate>,
): ResultDate
Type Parameters
- DateType extends Date
  The Date type, the function operates on. Gets inferred from passed arguments. Allows to use extensions like UTCDate.
- ResultDate extends Date = DateType
  The result Date type, it is the type returned from the context function if it is passed, or inferred from the arguments.
Parameters
- date: DateArg<DateType>
  The original date
- Optionaloptions: StartOfYearOptions<ResultDate>
  The options
Returns ResultDate
The start of a year
Name
startOfYear

Description
Return the start of a year for the given date. The result will be in the local timezone.
Example
```
// The start of a year for 2 September 2014 11:55:00:
const result = startOfYear(new Date(2014, 8, 2, 11, 55, 00))
//=> Wed Jan 01 2014 00:00:00
```
- Defined in node_modules/date-fns/startOfYear.d.ts:29