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

subscription-period-calculator

v1.0.1

Published

A function to calculate subscription periods

Downloads

5

Readme

Subscription Period Calculator

A simple and efficient TypeScript function to calculate subscription periods for monthly and yearly subscriptions.

Installation

You can install this package using npm:

npm install subscription-period-calculator

Usage

Here's how you can use the calculateSubscriptionPeriod function:

import { calculateSubscriptionPeriod } from 'subscription-period-calculator';

// Calculate yearly subscription period
const yearlyStart = new Date('2023-07-31T01:08:34.000Z');
const yearlyResult = calculateSubscriptionPeriod('yearly', 'start', yearlyStart);
console.log('Yearly subscription:');
console.log('Start:', yearlyResult.startDate);
console.log('End:', yearlyResult.endDate);

// Calculate monthly subscription period
const monthlyEnd = new Date('2023-07-31T01:08:34.000Z');
const monthlyResult = calculateSubscriptionPeriod('monthly', 'end', monthlyEnd);
console.log('Monthly subscription:');
console.log('Start:', monthlyResult.startDate);
console.log('End:', monthlyResult.endDate);

API

calculateSubscriptionPeriod(type, dateType, date) Calculates the start and end dates for a subscription period. Parameters:

  • type (SubscriptionType): 'monthly' or 'yearly'
  • dateType (DateInput): 'start' or 'end'
  • date (Date): The known date (either start or end date of the subscription)

Returns: An object with startDate and endDate properties, both of type Date. Testing To run the tests locally:

  1. Clone this repository
  2. Install dependencies: npm install
  3. Run the test script: npm test

The test script will run several test cases and output the results to the console.

Examples

Yearly Subscription

const yearlyStart = new Date('2023-07-31T01:08:34.000Z');
const result = calculateSubscriptionPeriod('yearly', 'start', yearlyStart);
// result.startDate: 2023-07-31T01:08:34.000Z
// result.endDate:   2024-07-31T01:08:34.000Z

Monthly Subscription

const monthlyEnd = new Date('2023-07-31T01:08:34.000Z');
const result = calculateSubscriptionPeriod('monthly', 'end', monthlyEnd);
// result.startDate: 2023-06-30T01:08:34.000Z
// result.endDate:   2023-07-31T01:08:34.000Z

Notes

  • For monthly subscriptions, the function handles edge cases like months with different numbers of days.
  • The function throws an error for invalid inputs (e.g., invalid date or subscription type).

License

This project is licensed under the MIT License.