index.js 2.8 KB

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