month-class/src/services/createNonWorkdays.js

Month class, manages information of the month from a given date

/**
 * @file Manages createNonWorkdays module, used to create nonworkdays property the
 * class Month.
 */

// ━━	FUNCTIONS	━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
/**
 * The `sortByNumber()` function sorts a number array.
 *
 * @private
 * @param   {number } first - The first element for comparison.
 * @param   {number } second - The second element for comparison.
 * @returns {Array<number>} The sorted array.
 * @example [100, 2, 1].sort(sortByNumber); // expected value [1, 2, 100]
 *
 */
const sortByNumber = (first, second) => first - second;

// ━━	MODULE	━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
/**
 * The `createNonWorkdays()` function returns a number array, that represent the
 * month's days that it is non workdays.
 *
 * The function requires an parameter `options`, must be an object with the
 * properties `weekends` and `holidays`.
 *
 * The `options.weekends` value must be a number array, that represents the
 * days of the month that are weekends. The values are like `Date.prototype.getDate()`.
 *
 * The `options.holidays` value must be a number array, that represents the
 * days of the month that are holidays. The values are like `Date.prototype.getDate()`.
 *
 * @private
 * @param   {object} options - Function options.
 * @param   {Array.<number>} options.weekends - An array with numeric elements.
 * @param   {Array.<number>} options.holidays - An array with numeric elements.
 * @returns {Array.<number>}  An array with numeric items.
 * @example const nonworkdays = createNonWorkdays({ weekends, holidays });
 *
 */
const createNonWorkdays = ({ weekends, holidays }) => Array.from(new Set([...weekends, ...holidays])).sort(sortByNumber); // eslint-disable-line prettier/prettier

// ━━	MODULE	━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
module.exports = createNonWorkdays;