index.js 2.6 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273
  1. import { getDefaultOptions, setDefaultOptions as setInternalDefaultOptions } from "../_lib/defaultOptions/index.js";
  2. import requiredArgs from "../_lib/requiredArgs/index.js";
  3. /**
  4. * @name setDefaultOptions
  5. * @category Common Helpers
  6. * @summary Set default options including locale.
  7. * @pure false
  8. *
  9. * @description
  10. * Sets the defaults for
  11. * `options.locale`, `options.weekStartsOn` and `options.firstWeekContainsDate`
  12. * arguments for all functions.
  13. *
  14. * @param {Object} newOptions - an object with options.
  15. * @param {Locale} [newOptions.locale] - the locale object. See [Locale]{@link https://date-fns.org/docs/Locale}
  16. * @param {0|1|2|3|4|5|6} [newOptions.weekStartsOn] - the index of the first day of the week (0 - Sunday)
  17. * @param {1|2|3|4|5|6|7} [newOptions.firstWeekContainsDate] - the day of January, which is always in the first week of the year
  18. * @throws {TypeError} 1 argument required
  19. *
  20. * @example
  21. * // Set global locale:
  22. * import { es } from 'date-fns/locale'
  23. * setDefaultOptions({ locale: es })
  24. * const result = format(new Date(2014, 8, 2), 'PPPP')
  25. * //=> 'martes, 2 de septiembre de 2014'
  26. *
  27. * @example
  28. * // Start of the week for 2 September 2014:
  29. * const result = startOfWeek(new Date(2014, 8, 2))
  30. * //=> Sun Aug 31 2014 00:00:00
  31. *
  32. * @example
  33. * // Start of the week for 2 September 2014,
  34. * // when we set that week starts on Monday by default:
  35. * setDefaultOptions({ weekStartsOn: 1 })
  36. * const result = startOfWeek(new Date(2014, 8, 2))
  37. * //=> Mon Sep 01 2014 00:00:00
  38. *
  39. * @example
  40. * // Manually set options take priority over default options:
  41. * setDefaultOptions({ weekStartsOn: 1 })
  42. * const result = startOfWeek(new Date(2014, 8, 2), { weekStartsOn: 0 })
  43. * //=> Sun Aug 31 2014 00:00:00
  44. *
  45. * @example
  46. * // Remove the option by setting it to `undefined`:
  47. * setDefaultOptions({ weekStartsOn: 1 })
  48. * setDefaultOptions({ weekStartsOn: undefined })
  49. * const result = startOfWeek(new Date(2014, 8, 2))
  50. * //=> Sun Aug 31 2014 00:00:00
  51. */
  52. export default function setDefaultOptions(newOptions) {
  53. requiredArgs(1, arguments);
  54. var result = {};
  55. var defaultOptions = getDefaultOptions();
  56. for (var property in defaultOptions) {
  57. if (Object.prototype.hasOwnProperty.call(defaultOptions, property)) {
  58. ;
  59. result[property] = defaultOptions[property];
  60. }
  61. }
  62. for (var _property in newOptions) {
  63. if (Object.prototype.hasOwnProperty.call(newOptions, _property)) {
  64. if (newOptions[_property] === undefined) {
  65. delete result[_property];
  66. } else {
  67. ;
  68. result[_property] = newOptions[_property];
  69. }
  70. }
  71. }
  72. setInternalDefaultOptions(result);
  73. }