📦 Installation

npm i formatterdate --save
yarn add formatterdate

🔮 Importing

import formatterDate from "formatterdate"; // esm
const formatterDate = require("formatterdate"); // common

📝 Usage

const formatterDate = require("formatterdate");

const current = Date.now();
const start = 1650211118829;
const msg = `{year} years, {month} months, {day} days, {hours} hours, {minutes} minutes, {seconds} seconds`;
const end = 1650213606096;

/*
    function: formatElapsedTime(current, start, msg, object)
    output: {
      seconds: 22,
      minutes: 0,
      hours: 0,
      day: 0,
      month: 0,
      year: 0,
    };
*/

formatterDate.formatElapsedTime(current, start, false, true);

/*
    function: formatRemainingTime(currentTime, endTime, msg, object)
    output: 1 hours 28 minutes 60 seconds
*/

formatterDate.formatRemainingTime(current, end, msg, false);

// Format

/*
    function: formatterDate.format(format, date)
    date: e.g 1650211118829
    format: e.g YYYY-MM-DD HH:mm:ss
    output: 2020-01-01 00:00:00
*/

const date = formatterDate.format("MMMM Do YYYY, h:mm:ss a");

// FromNow()

/*
    function: formatterDate.fromNow(date, now)
    date: e.g 1650211118829
    output: 50 minutes ago
*/

const fromnow = formatterDate.fromNow(1650211118829, 1650214167345);

🤝 Contributing

Contributions, issues and feature requests are welcome!Feel free to check issues page.

License

Webscreen is licensed under the [MIT License]. The terms of the license are as follows:

The MIT License (MIT)

Copyright (c) 2022 - Roxza

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.