compareDesc

Compare the two dates reverse chronologically and return -1, 0 or 1.

Description

Compare the two dates and return -1 if the first date is after the second, 1 if the first date is before the second or 0 if dates are equal.

Usage

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

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

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

Syntax

compareDesc(dateLeft, dateRight)

Arguments

Name	Description
dateLeft	the first date to compare
dateRight	the second date to compare

Returns

Description
the result of the comparison

Exceptions

Type	Description
TypeError	2 arguments required

Examples

// Compare 11 February 1987 and 10 July 1989 reverse chronologically:
const result = compareDesc(new Date(1987, 1, 11), new Date(1989, 6, 10))
//=> 1

// Sort the array of dates in reverse chronological order:
const result = [
  new Date(1995, 6, 2),
  new Date(1987, 1, 11),
  new Date(1989, 6, 10)
].sort(compareDesc)
//=> [
//   Sun Jul 02 1995 00:00:00,
//   Mon Jul 10 1989 00:00:00,
//   Wed Feb 11 1987 00:00:00
// ]