1.1.0 • Published 3 years ago
countdown-x v1.1.0
How to install
You can using a in 2 way
npm install countdown-x
npm i countdown-x
How to use
See the example below to use it
var countdownX = require("countdown-x");
// Using: countdown
setInterval(() => {
// it's was called every seconds
console.log(countdownX.fromNow().countdown("2033/12/10 16:23:00")) // {days: 8, hours: "00", minutes: "05", months: 2, seconds: 44, years: 13}
}, 1000)
// Using: countdownEvery
countdownX
.fromNow()
.countdownEvery("2033/12/10 16:23:00", { ms: 1000 }, (values) => {
// Do something with values
// it's was called every seconds
console.log(values); // {days: 8, hours: "00", minutes: "05", months: 2, seconds: 44, years: 13}
});
Documentation
- eventDate format (ISO 8601 - UTC): yyyy/mm/dd HH:MM:SS
API | Description | Return |
---|---|---|
fromNow() | Setup countdown destination | void |
countdown(eventDate) | The countdown function | {days, hours, minutes, months, seconds, years} |
countdownEvery(eventDate, options{ms: number}, callback) | The countdown function automatically according to predetermined time | void |
Versions history
The version | Description | Issues |
---|---|---|
v1.0.0 | Project initialization | No issue |
v1.0.1 | Clean code | No issue |
v1.0.2 | Clean code | No issue |
v1.0.3 | Clean code | No issue |
v1.0.4 | Fix | The countdown time is wrong |
v1.0.4-1 | Refactoring the source code | Structure |
v1.0.4-2 | Change example code | No issue |
v1.0.5 | Add type and supported suggest code | No issue |
v1.1.0 | add new function support auto setInterval | No issue |