date.startOfYear()

The startOfYear method returns a new NepaliDate instance set to 1 Baisakh, the first day of the Bikram Sambat calendar year. This is useful for year to date financial tracking and annual summary reports.

ImportCopy Anchor Link

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

SignatureCopy Anchor Link

startOfYear(): NepaliDate;

ParametersCopy Anchor Link

This method does not take any parameters.

Return ValueCopy Anchor Link

• Type: NepaliDate
• Returns a new NepaliDate set to 1st Baisakh of the current year. The original instance is not modified.

ExamplesCopy Anchor Link

Navigating to Bikram Sambat New YearCopy Anchor Link

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

// Any date within 2081 BS
const date = new NepaliDate("2081-08-15");

const newYear = date.startOfYear();
console.log(newYear.format("YYYY-MM-DD")); // "2081-01-01"
console.log(newYear.getMonth()); // 0 (Baisakh)
console.log(newYear.getDate()); // 1

Year-to-Date CalculationsCopy Anchor Link

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

const today = new NepaliDate("2081-06-15");
const yearStart = today.startOfYear();

const daysElapsed = today.diff(yearStart, "day");
console.log(daysElapsed); // Number of days since start of the year

RelatedCopy Anchor Link

• date.endOfYear(): Return the final day of the Bikram Sambat year.
• date.startOfMonth(): Return the first day of the current month.
• date.getYear(): Retrieve current Bikram Sambat year number.