timepiece/node_modules/date-fns/getDefaultOptions.d.mts

27 lines
785 B
TypeScript
Raw Normal View History

2024-05-14 14:54:12 +00:00
import type { DefaultOptions } from "./_lib/defaultOptions.js";
/**
* @name getDefaultOptions
* @category Common Helpers
* @summary Get default options.
* @pure false
*
* @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](https://date-fns.org/docs/setDefaultOptions).
*
* @returns The default options
*
* @example
* const result = getDefaultOptions()
* //=> {}
*
* @example
* setDefaultOptions({ weekStarsOn: 1, firstWeekContainsDate: 4 })
* const result = getDefaultOptions()
* //=> { weekStarsOn: 1, firstWeekContainsDate: 4 }
*/
export declare function getDefaultOptions(): DefaultOptions;