date.endOfWeek()

The endOfWeek method produces a new NepaliDate instance representing the last day of the week containing the current date. In standard Nepali calendar practice, Saturday is regarded as the final day of the weekly cycle.

ImportCopy Anchor Link

import { NepaliDate } from "nepali-date-library";

SignatureCopy Anchor Link

endOfWeek(startOfWeek?: number): NepaliDate;

ParametersCopy Anchor Link

Return ValueCopy Anchor Link

• Type: NepaliDate
• Returns a new NepaliDate instance set to the end of the final day of the week (23:59:59.999). The original instance is not modified.

ExceptionsCopy Anchor Link

Throws an Error if startOfWeek is not an integer between 0 and 6:

"startOfWeek must be an integer between 0 and 6"

ExamplesCopy Anchor Link

Default Week End (Saturday 23:59:59)Copy Anchor Link

import { NepaliDate } from "nepali-date-library";

const date = new NepaliDate("2081-02-16");

const weekEnd = date.endOfWeek();
console.log(weekEnd.getDay()); // 6 (Saturday)
console.log(weekEnd.getHours()); // 23
console.log(weekEnd.getMinutes()); // 59

Custom Week Ending on SundayCopy Anchor Link

import { NepaliDate } from "nepali-date-library";

const date = new NepaliDate("2081-02-16");

// Week starts on Monday (1), meaning it ends on Sunday (0)
const weekEnd = date.endOfWeek(1);
console.log(weekEnd.getDay()); // 0 (Sunday)

RelatedCopy Anchor Link

• date.startOfWeek(): Return the beginning of the week.
• date.endOfDay(): Return end of the day.
• date.getDay(): Get current day of week index (0-6).