closestTo

Return a date from the array closest to the given date.

Description

Return a date from the array closest to the given date.

Usage

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

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

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

Syntax

closestTo(dateToCompare, datesArray)

Arguments

Name	Description
dateToCompare	the date to compare with
datesArray	the array to search

Returns

Description
the date from the array closest to the given date or undefined if no valid value is given

Exceptions

Type	Description
TypeError	2 arguments required

Examples

// Which date is closer to 6 September 2015: 1 January 2000 or 1 January 2030?
const dateToCompare = new Date(2015, 8, 6)
const result = closestTo(dateToCompare, [
  new Date(2000, 0, 1),
  new Date(2030, 0, 1)
])
//=> Tue Jan 01 2030 00:00:00