Twix

Twix is a simple but opinionated JS library for working with date ranges, and includes a customizable smart formatter. It's written in CoffeeScript and it depends on Moment.js.

It allows you to do, among other things, this:

var t = moment("1982-01-25T09:30").twix("1982-01-25T13:30");

t.format();  //=> Jan 25, 1982, 9:30 AM - 1:30 PM

t.isSame("day"); //=> true
t.humanizeLength(); //=> "4 hours"
t.count("days"); //=> 1

And much more.

Documentation

Attention Moment 2.10.x users: You need to upgrade to the latest Twix! You also should make sure not to be on Moment 2.10.0 (i.e. upgrade to the latest point release) because it has some compatibility issues with Twix.

Breaking change in 0.6.0 Twix ranges will ignore changes to their endpoints; once you create the range, it's frozen in place. Construct new ranges to grow/shrink.

Building

If you want to build Twix for yourself, clone the repo and run this:

make configure build

Configure just installs the NPMs (including CoffeeScript) and brings in Moment as a submodule, so you only have to do that part once.

Note that the source is src/twix.coffee; the output is bin/twix.js. You can run the tests via

make test

You can also run the tests in-browser by building and then loading test/test.html.

Contributing

Patches are welcome!

• Submit pull requests to the develop branch. I merge develop to master when we cut a release.
• Don't include your changes to the generated .js files in the patch; they're much harder to merge. I'll generate them when I cut the release.

Changelog

• 0.6.4: Use peerDependency for Moment

• 0.6.3: Moment 2.10 compatibility

• 0.6.2: Fix iterate for months

• 0.6.1: Meteor support

• 0.6.0: Moment deprecations, s/lang/locale, xor, intersection, split, difference, immutability

• 0.5.1: Make Twix compatible with Moment 2.8.1

• 0.5.0: Fix intersection/overlap behavior (#36), expand signature, and deal with Moment deprecations.

• 0.4.0: Simplified internationalization support (possibly breaking change for those few people using French support), added more complex iteration durations. Reverted build complexity.

• 0.3.0: AMD support, basic internationalization support, bug fix for countInner and iterateInner. Component and bower support. New build system and code organization.

• 0.2.2: Added isValid and intersection, fixed overlaps for adjacent times, renamed merge to union, added deprecation warnings.

• 0.2.1: Added countInner, contains, iterateInner, and length

• 0.2.0: Deprecated sameDay, sameYear, countDays, daysIn, past, and duration. Added isSame, humanizeLength, asDuration, isPast, isFuture, isCurrent. Added duration methods. Emphasized moment() monkey patch methods over Twix() constructor. Some bug fixes.

• Older versions - wasn't tracking.

License (MIT)

Copyright (c) 2012 Isaac Cambron

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.