Cypress Documentation | JSDOC

[scottqueen-bixal]

Description

Provide JSDOC documentation for our functions and test

https://jsdoc.app/

for example:

/**
 * Returns a date object with the specified offset added to the current date.
 * @param {number} offset - The number of days to add to the current date.
 * @returns {Object} An object containing the month, day, and year.
 * @example
 * getDateByOffset(10); // returns { month: "05 - May", day: "25", year: 2023 }
 */
export function getDateByOffset(offset) {
  const date = new Date(Date.now());
  const n = Number(offset);

  date.setDate(date.getDate() + n);
  const month = ('0' + (date.getMonth() + 1)).slice(-2);
  const monthName = date.toLocaleString('default', { month: 'long' });
  const day = ('0' + date.getDate()).slice(-2);
  const year = date.getFullYear();

  return { month: month + ' - ' + monthName, day, year };
}

User Story

No response

Acceptance Criteria

No response