123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778 |
- import {
- getDefaultOptions,
- setDefaultOptions as setInternalDefaultOptions,
- } from "./_lib/defaultOptions.js";
- /**
- * @name setDefaultOptions
- * @category Common Helpers
- * @summary Set default options including locale.
- * @pure false
- *
- * @description
- * Sets the defaults for
- * `options.locale`, `options.weekStartsOn` and `options.firstWeekContainsDate`
- * arguments for all functions.
- *
- * @param options - An object with options
- *
- * @example
- * // Set global locale:
- * import { es } from 'date-fns/locale'
- * setDefaultOptions({ locale: es })
- * const result = format(new Date(2014, 8, 2), 'PPPP')
- * //=> 'martes, 2 de septiembre de 2014'
- *
- * @example
- * // Start of the week for 2 September 2014:
- * const result = startOfWeek(new Date(2014, 8, 2))
- * //=> Sun Aug 31 2014 00:00:00
- *
- * @example
- * // Start of the week for 2 September 2014,
- * // when we set that week starts on Monday by default:
- * setDefaultOptions({ weekStartsOn: 1 })
- * const result = startOfWeek(new Date(2014, 8, 2))
- * //=> Mon Sep 01 2014 00:00:00
- *
- * @example
- * // Manually set options take priority over default options:
- * setDefaultOptions({ weekStartsOn: 1 })
- * const result = startOfWeek(new Date(2014, 8, 2), { weekStartsOn: 0 })
- * //=> Sun Aug 31 2014 00:00:00
- *
- * @example
- * // Remove the option by setting it to `undefined`:
- * setDefaultOptions({ weekStartsOn: 1 })
- * setDefaultOptions({ weekStartsOn: undefined })
- * const result = startOfWeek(new Date(2014, 8, 2))
- * //=> Sun Aug 31 2014 00:00:00
- */
- export function setDefaultOptions(options) {
- const result = {};
- const defaultOptions = getDefaultOptions();
- for (const property in defaultOptions) {
- if (Object.prototype.hasOwnProperty.call(defaultOptions, property)) {
- // [TODO] I challenge you to fix the type
- result[property] = defaultOptions[property];
- }
- }
- for (const property in options) {
- if (Object.prototype.hasOwnProperty.call(options, property)) {
- if (options[property] === undefined) {
- // [TODO] I challenge you to fix the type
- delete result[property];
- } else {
- // [TODO] I challenge you to fix the type
- result[property] = options[property];
- }
- }
- }
- setInternalDefaultOptions(result);
- }
- // Fallback for modularized imports:
- export default setDefaultOptions;
|