/businessday

💼📊 A lib that calculates a deadline considering only working days business days

Primary LanguageTypeScriptMIT LicenseMIT

Business Day Project

💼📊 A lib that calculates a deadline considering only working days business days

About the project   |    Technologies   |    Getting started   |    How to contribute   |    License

💇🏻‍♂️ About the project

This project contains functions that assist in the calculation of deadlines on working days

🚀 Technologies

Technologies that I used to develop this api

💻 Getting started

Requirements

Install lib

$ yarn add businessday-workingdays

Available methods

getDeadline({
    date: new Date(),
    deadline: 5
})

// This method returns the added informed date of 5 business days
getdifferenceInBusinessDays({
    date: new Date(),
    deadline: 5
});

// This method returns the number of working days between the end date and the one informed

🤔 How to contribute

Make a fork of this repository

# Fork using GitHub official command line
# If you don't have the GitHub CLI, use the web site to do that.

$ gh repo fork dudubernardino/businessday

Follow the steps below

# Clone your fork
$ git clone your-fork-url && cd businessday

# Create a branch with your feature
$ git checkout -b my-feature

# Make the commit with your changes
$ git commit -m 'feat: My new feature'

# Send the code to your remote branch
$ git push origin my-feature

After your pull request is merged, you can delete your branch

📝 License

This project is licensed under the MIT License - see the LICENSE file for details.

Made with 💜  by Eduardo Bernardino 👋  See my linkedin