getDefaultOptions

Get default options.

Description

Returns an object that contains defaults for options.locale, options.weekStartsOn and options.firstWeekContainsDate arguments for all functions.

You can change these with [setDefaultOptions]{@link https://date-fns.org/docs/setDefaultOptions}.

Usage

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

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

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

Returns

Description
default options

Examples

const result = getDefaultOptions()
//=> {}

setDefaultOptions({ weekStarsOn: 1, firstWeekContainsDate: 4 })
const result = getDefaultOptions()
//=> { weekStarsOn: 1, firstWeekContainsDate: 4 }