startOfYear

Return the start of a year for the given date.

Description

Return the start of a year for the given date. The result will be in the local timezone.

Usage

// CommonJS
var startOfYear = require('date-fns/startOfYear')

// ES 2015
import startOfYear from 'date-fns/startOfYear'

// ESM
import { startOfYear } from 'date-fns'

Syntax

startOfYear(date)

Arguments

Name	Description
date	the original date

Returns

Description
the start of a year

Exceptions

Type	Description
TypeError	1 argument required

Examples

// 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