sec-countdown
v1.0.0
Published
This is a simple Node.js timer application that allows you to set a timer for a specific number of seconds, up to a maximum of 6 hours. It uses the `date-fns` library for date calculations and `inquirer` for user input.
Downloads
1
Readme
Node.js and Typescript Countdown Timer
This is a simple Node.js timer application that allows you to set a timer for a specific number of seconds, up to a maximum of 6 hours. It uses the date-fns
library for date calculations and inquirer
for user input.
Features
- Set a timer for a specified number of seconds.
- Provides a visual countdown in the format
HH:MM:SS
. - Timer expires when the countdown reaches zero, and a message is displayed.
Installation
Clone this repository to your local machine:
git clone https://github.com/Suleman1411/typescript-nodejs-countdown-timer
Change to the project directory:
cd typescript-nodejs-countdown-timer
Install the required dependencies:
npm install
Usage
To start the timer, run the following command:
npm index.js
You will be prompted to enter the number of seconds for the timer. The timer will start counting down, and the remaining time will be displayed in the console. Once the timer expires, a message will be shown, and the application will exit.
Configuration
You can adjust the maximum timer duration by changing the input > 21600
condition in the validate
function of the inquirer
prompt. By default, the maximum timer duration is set to 6 hours (21,600 seconds).
Dependencies
- date-fns: A library for working with dates in JavaScript.
- inquirer: A collection of common interactive command line user interfaces.
License
This project is licensed under the MIT License - see the LICENSE file for details.
Author
- Suleman Pervez
- GitHub: Suleman1411
Acknowledgments
Special thanks to the authors of the date-fns
and inquirer
libraries for their excellent work.
Contributing
If you'd like to contribute to this project, please follow these guidelines:
- Fork the repository.
- Create a new branch for your feature or bug fix.
- Make your changes and commit them with a descriptive commit message.
- Push your changes to your fork.
- Submit a pull request to this repository.
We welcome contributions and appreciate your help in making this project better.