npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

fiscal

v1.0.0

Published

Computes fiscal quarter and year date ranges

Downloads

8,676

Readme

Fiscal

Fiscal provides a simple interface to calculate the calendar dates for fiscal years and quarters. Fiscal has no dependencies and also offers a browser build (see fiscal.min.js).

Usage

const Fiscal = require('fiscal');
const fiscal = new Fiscal(9); // Specify the 0-indexed month that your fiscal year starts

// get information about the current year
fiscal.getFiscalInfoForDate().fiscalYear
// returns { fiscalYear: 2017, fiscalMonth: 9 }

API

Fiscal can give you information using the current date or one you specify.

Instantiation

Before you start using Fiscal, you need to tell Fiscal what calendar month your fiscal year starts on. This should be zero-indexed (as per JS's Date implementation).

For example, if your fiscal year starts in October, you would do:

const fiscal = new Fiscal(9);

fiscal.getFiscalInfoForDate([Date])

Provides information based on the provided date.

fiscal.getFiscalInfoForDate();

Parameters:

  • Date Creates a Fiscal instance for the provided date object. If no date is provided, Fiscal will use the current date.

Returns an object containing information about the provided date.

{
    fiscalYear: '[instance of FiscalYear]',
    quarter: '[instance of Quarter]',
    calendar: {
        calendarMonth: '[zero-indexed calendar month]',
        calendarYear: '[calendar year]'
    }
}

FiscalYear.startDate

Returns the starting date for the fiscal year.

const info = fiscal.getFiscalInfoForDate();
info.fiscalYear.startDate // Date: 2016-10-01T00:00:00.000Z

FiscalYear.endDate

Returns the ending date for the fiscal year.

const info = fiscal.getFiscalInfoForDate();
info.fiscalYear.endDate // Date: 2017-09-00T23:59:59.999Z

FiscalYear.previous()

Returns a new instance of FiscalYear representing the previous fiscal year.

const info = fiscal.getFiscalInfoForDate();
const prevFy = info.fiscalYear.previous();

FiscalYear.next()

Returns a new instance of FiscalYear representing the next fiscal year.

const info = fiscal.getFiscalInfoForDate();
const nextFy = info.fiscalYear.next();

Quarter.startDate

Returns the starting date for the fiscal year.

const info = fiscal.getFiscalInfoForDate();
info.quarter.startDate // Date: 2016-10-01T00:00:00.000Z

Quarter.endDate

Returns the ending date for the fiscal year.

const info = fiscal.getFiscalInfoForDate();
info.quarter.endDate // Date: 2016-12-31T23:59:59.999Z

Quarter.previous()

Returns a new instance of Quarter representing the previous quarter.

const info = fiscal.getFiscalInfoForDate();
const prevQuarter = info.quarter.previous();

Quarter.next()

Returns a new instance of Quarter representing the next quarter.

const info = fiscal.getFiscalInfoForDate();
const nextQuarter = info.quarter.next();

Running Tests

To run the tests, simply run npm test.

Misc

This module was developed by Mark Herhold at RTI International. It is available for use under the MIT license. Pull requests are appreciated and welcome.