11

Github GitHub - Artiry/globol: General-purpose time library for Javascript/Types...

 3 years ago
source link: https://github.com/Artiry/globol
Go to the source link to view the article. You can view the picture content, updated content and better typesetting reading experience. If the link is broken, please click the button below to view the snapshot at that time.
neoserver,ios ssh client
Artiry/globol: General-purpose time library for Javascript/Typescript

Date & time library for Javascript/Typescript
Made with the user (that's you! the programmer!) in mind.

  • Dates, times, time zones, durations, week days...
  • Based on ideas taken from the amazing Java java.time library.
  • Type safe. No more comparing apples and oranges when it comes to dates. You want to express a moment in time, a date on the calendar, a time on the clock? With or without a timezone, or maybe a zone offset? No longer are these concepts all thrown into one object, or worse, no object at all.
  • Immutable. The 00s are long gone, but still gets a mention.
  • Fail early. Arithmetics with dates can get complex enough. To reduce complexity, you need to know that your date objects are what you think they are. So Globol checks its input, and throws Errors with helpful messages if there's something wrong.
  • Fluent. No searching the web for which functions suit your needs, but intuitive use with auto-complete and in-place method/class/function documentation.
  • ISO-8601-compliant serilization/deserialization of all data representations.
  • Under the hood, currently uses the well-tested, well-trusted moment.js internally for parsing, formatting and time zone conversions.
  • Uses moment-timezone for time zone information. Future work is to make this optionally injectable, so globol can be smaller for users that need it to be.

Example:

const currentTimeInNewYork = LocalDateTime
    .now()
    .atZone(ZoneId.of('America/New_York')) // returns a ZonedDateTime
    .toLocalTime(); // returns a LocalTime

Install

npm install globol

Usage examples

Get the current timestamp

Instant.now() // returns an Instant

Get the current time on the clock (e.g. '14:57') in Berlin

Instant.now()
    .atZone(ZoneId.of('Europe/Berlin')) // returns a ZonedDateTime
    .toLocalTime() // returns a LocalTime

Core concepts

This library consists of a few key datatypes. The library provides plenty of methods to convert between instantiations of them. The following are the most important datatypes, the ones that you should know of.

Instant

This is a moment in physical time. This is the thing you will likely use most often.

LocalDateTime

A date with a time, e.g. 2020-01-20T19:34

LocalDate

A date, e.g. 2020-01-20

LocalTime

A time, e.g. 08:34:00.000

ZonedDateTime

A datetime with a zone offset, e.g. 2020-01-20T19:34Z+01. Because it has an offset, it points to an unambiguous point in physical time, like Instant. Unlike Instant, however, this object cares about how the datetime is represented. For example: there can be a ZonedDateTime 2020-01-20T19:00Z+01 and a ZonedDateTime 2020-01-20T18:00Z+00. They both correspond to the same moment in physical time, i.e. the same Instant, but they are two distinct ZonedDateTimes.

Duration

A fixed length of physical time.

ZoneId & ZoneOffset

These represent timezones. The difference between ZoneId and ZoneOffset is as follows: ZoneId represents something like Europe/Amsterdam, which can have a ZoneOffset of +1 in the winter and +2 in the summer.

Future work

We'd like to make it optional to use the moment-timezone library. To make a separate library globol-timezone that has globol as an npm peer dependency, which, when included, runtime-enriches Globol with the moment-timezone time zone information.

Feedback

If something is missing from this library that makes it not fit your use case today, or if you find a bug that spoils it for you, don't hesitate to create an Issue or a Pull Request. Feedback and contributions are sincerely appreciated.

License

The content of this project is licensed under the MIT license.


report

Recommend

About Joyk


Aggregate valuable and interesting links.
Joyk means Joy of geeK