GithubHelp home page GithubHelp logo

researchgate / moment-shortformat Goto Github PK

View Code? Open in Web Editor NEW
16.0 18.0 5.0 82 KB

moment-shortformat.js is an extension to moment.js that formats dates in a short format like it's used on ResearchGate.

License: MIT License

JavaScript 100.00%

moment-shortformat's Introduction

Short Date Formatter Build Status npm

moment-shortformat.js is an extension to moment.js that formats dates in a short format like it's used on ResearchGate.

Absolute time difference output of moment.short()
0 to 59 seconds 1s to 59s
1 to 59 minutes 1m to 59m
1 to 23 hours 1h to 23h
1 to 6 days 1d to 6d
>= 7 days but same year e.g Sep 3 or Feb 28
>= 7 days but different year e.g Sep 3, 2023 or Feb 28, 1989

It works for both negative and positive time differences.

Usage

Works with AMD, CommonJS and browser environments.

// AMD
define(['moment-shortformat'], function(moment) { moment().short() });
// CommonJS
var moment = require('moment-shortformat');
moment().short()
<!-- Browser -->
<script type="text/javascript" src="/moment.js"></script>
<script type="text/javascript" src="/moment-shortformat.js"></script>
<script type="text/javascript">
    moment().short();
</script>

Works on both past and future dates.

Methods

moment().short(Boolean, now)

Short formatting the time difference and prefixing or suffixing the formatted time by using moment.js relativeTime templates future and past. (default in %s and %s ago)

If the boolean parameter is set to true the date format will not be prefixed or suffixed.

If the now parameter is set to a moment() it will use that as the "now" difference

Examples:

Formats time relative to current time.

moment(moment() + (36e5 * 5)).short() // in 5h
moment(moment() - (36e5 * 5)).short() // 5h ago
moment(moment() + (36e5 * 5)).short(true) // 5h
moment(moment() - (36e5 * 5)).short(true) // 5h

Times greater than 1 week are converted to dates like Mar 7, or if the year of the date does not match the current year it is convert to Mar 7, 2031

moment(moment() + 6048e5).short()
// Mar 7

Using a different "now"

moment(moment() + (36e5 * 5)).short(false, moment() + (36e5 * 3)) // in 2h

moment-shortformat's People

Contributors

danez avatar greenkeeper[bot] avatar blanchg avatar

Stargazers

madhankumar avatar Qdigital avatar Rabbit avatar  avatar Arman Dezfuli-Arjomandi avatar  avatar Ken avatar Luis Merino avatar Diego Santiesteban avatar Leonard Pauli avatar Syed Aman avatar  avatar Charlie Smith avatar Mathieu M-Gosselin avatar Steven Langbroek avatar  avatar

Watchers

Igor avatar Fabrizio Schmidt avatar Vyacheslav Zholudev avatar Yaroslav avatar Dejan Menges avatar James Cloos avatar Tim von Oldenburg avatar Olexiy Kyrychenko avatar Darijusch Behbahani avatar Frank Bewersdorff avatar Roland Lösslein avatar Jeramy W avatar Sebastian Klemke avatar Sibylle K Lancaster avatar  avatar Marcus Lancaster avatar  avatar  avatar

moment-shortformat's Issues

Version 10 of node.js has been released

Version 10 of Node.js (code name Dubnium) has been released! 🎊

To see what happens to your code in Node.js 10, Greenkeeper has created a branch with the following changes:

  • Added the new Node.js version to your .travis.yml
  • The new Node.js version is in-range for the engines in 1 of your package.json files, so that was left alone

If you’re interested in upgrading this repo to Node.js 10, you can open a PR with these changes. Please note that this issue is just intended as a friendly reminder and the PR as a possible starting point for getting your code running on Node.js 10.

More information on this issue

Greenkeeper has checked the engines key in any package.json file, the .nvmrc file, and the .travis.yml file, if present.

  • engines was only updated if it defined a single version, not a range.
  • .nvmrc was updated to Node.js 10
  • .travis.yml was only changed if there was a root-level node_js that didn’t already include Node.js 10, such as node or lts/*. In this case, the new version was appended to the list. We didn’t touch job or matrix configurations because these tend to be quite specific and complex, and it’s difficult to infer what the intentions were.

For many simpler .travis.yml configurations, this PR should suffice as-is, but depending on what you’re doing it may require additional work or may not be applicable at all. We’re also aware that you may have good reasons to not update to Node.js 10, which is why this was sent as an issue and not a pull request. Feel free to delete it without comment, I’m a humble robot and won’t feel rejected 🤖


FAQ and help

There is a collection of frequently asked questions. If those don’t help, you can always ask the humans behind Greenkeeper.


Your Greenkeeper Bot 🌴

Allow moment().from() syntax

Hi,
I need to be able to customize the "now" being used in .short().
More than happy to add this and submit a pull request if you would like.
What is your preference for the implementation, a new parameter to the existing .short() method or a new method?

e.g.
moment().short(false, now)

Moment itself uses two methods .fromNow() and .from(now) but that would mean a breaking change to your api which probably isn't really necessary.

Thanks!

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.