\n ![\"spacetime](\"https://user-images.githubusercontent.com/399657/31140478-80a4269a-a842-11e7-8dbf-b541fe3e87a7.png\")
\n
\n\n \n \n ![](\"https://img.shields.io/npm/v/spacetime.svg?style=flat-square\")
\n \n \n ![](\"https://user-images.githubusercontent.com/399657/68221862-17ceb980-ffb8-11e9-87d4-7b30b6488f16.png\"/)
\n\nIsn't it weird how we can do math in our head, but not date math?\n\n- how many days until the end of the year?\n-what time was it, 11 hours ago?\n-is it lunchtime in france?\n\n\nand worse - there is no real **_date calculator_**.\n\n\n\n\n\nspacetime is a date-calculator,\n\nIt's very small, and very handy.\n\n\n![](\"https://user-images.githubusercontent.com/399657/68221814-05ed1680-ffb8-11e9-8b6b-c7528d163871.png\"/)
\n\n\n- calculate time in remote timezones\n- support **daylight savings**, **leap years**, and **hemispheres**\n- [Moment-like API](https://beta.observablehq.com/@spencermountain/spacetime-api) _(but immutable)_\n- Orient time by quarter, season, month, week..\n- _Zero Dependencies_ - (no _[Intl API](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl)_)\n- weighs about 40kb.\n- has a cool _[plugin thing](https://observablehq.com/@spencermountain/spacetime)_.\n- frequent updates for approaching DST changes\n- support for upcoming [Temporal](https://tc39.es/proposal-temporal/docs/) standards\n\n\n\n\n\n```html\n\n\n```\n\n\n\n\n`npm install spacetime`\n\n```js\nconst spacetime = require('spacetime')\nlet d = spacetime.now('Europe/Paris')\nd.dayName()\n//'Wednesday'\nd.isAsleep()\n//true\n```\n\ntypescript / babel / deno:\n\n```ts\nimport spacetime from 'spacetime'\nlet d = spacetime.now()\nd.format('nice')\n//'Apr 1st, 4:32pm'\n```\n\nAGENTS.md LLM docs\n\n\n\n\n\n\n\nplugins:\n\n \n \n\n\n\n### Date Inputs:\n\nwe can parse _[all the normal stuff](https://github.com/spencermountain/spacetime/wiki/Input)_, and some fancy stuff:\n\n```js\n//epoch\ns = spacetime(1489520157124)\n\n//array [yyyy, m, d] (zero-based months, 1-based days)\ns = spacetime([2017, 5, 2])\n\n//iso\ns = spacetime('July 2, 2017 5:01:00')\n\n// All inputs accept a timezone, as 2nd param:\ns = spacetime(1489520157124, 'Canada/Pacific')\ns = spacetime('2019/05/15', 'Canada/Pacific')\n\n// or set the offset right in the date-string (ISO-8601)\ns = spacetime('2017-04-03T08:00:00-0700')\n// 'Etc/GMT-7'\n\n// Some helpers\ns = spacetime.now()\ns = spacetime.today() // This morning\ns = spacetime.tomorrow() // Tomorrow morning\ns = spacetime.min() // the earliest-possible date (271,821 bc)\ns = spacetime.max() // the furthest-possible future date (27k years from now)\n\n// To get the native Date object back\n// (this bails back to the local timezone)\njsDate = spacetimeDate.toNativeDate()\n```\n\nfor fancier natural-language inputs, use [compromise-dates](https://github.com/spencermountain/compromise/tree/master/plugins/dates).\n\n\n\n### Get & Set dates:\n\nyou can whip things around, but stay intuitive\n\n```js\ns.date() // 14\ns.year() // 2017\ns.season() // Spring\ns = s.hour(5) // Change to 5am\ns = s.date(15) // Change to the 15th\n\ns = s.day('monday') // Change to (this week's) monday\ns = s.day('monday', true) // go forward to monday\ns = s.day('monday', false) // go backward to monday\n\ns = s.month('march') // Change to (this year's) March 1st\ns = s.quarter(2) // Change to April 1st\ns.era() // 'BC'/'AD'\ns.decade() // 2000\ns.century() // 21\n\n// Percentage-based information\ns.progress().month // 0.23 - we're a quarter way through the month\ns.progress().day // 0.48 - almost noon\ns.progress().hour // 0.99 - 59 minutes and 59 seconds\n\n// Add/subtract methods\ns = s.add(1, 'week')\ns = s.add(3, 'quarters')\ns = s.subtract(2, 'months').add(1, 'day')\n\n// start-of/end-of\ns = s.startOf('day') // 12:00am\ns = s.startOf('month') // 12:00am, April 1st\ns = s.endOf('quarter') // 11:59:59pm, June 30th\n\ns = s.nearest('hour') //round up/down to the hour\ns = s.nearest('quarter-hour') //5:15, 5:30, 5:45..\ns = s.next('month') //start of the next month\ns = s.last('year') //start of the last year\n\n// fill-in all dates between a range\ns.every('week', 'Jan 1st 2020') // (in tz of starting-date)\n\n//utilities:\ns.clone() // Make a copy\ns.isValid() // Sept 32nd → false\ns.isAwake() // it's between 8am → 10pm\ns.json() // get values in every unit as key-val object\n```\n\nif it's **_9am on tuesday_**, and you add a week, it will still be 9am on tuesday.\n... even if some crazy changes happen.\n\nsetter methods also support a handy 2nd param that controls whether it should be set forward, or backward.\n\n```js\ns = s.time('4:00pm') // 4pm today\ns = s.time('4:00pm', true) // the next 4pm in the future\ns = s.time('4:00pm', false) // the most-recent 4pm\n\ns = s.set('march 5th 2020')\ns = s.set('march 4th') // 2020 (same year)\ns = s.set('march 4th', true) // 2021\ns = s.set('march 6th', false) // 2019\n```\n\nit's actually a little surprising how helpful this is.\n\n\n\n### Comparisons:\n\n```js\nlet s = spacetime([2017, 5, 2])\nlet start = s.subtract(1, 'milliseconds')\nlet end = s.add(1, 'milliseconds')\n\n// gt/lt/equals\ns.isAfter(d) // True\ns.isEqual(d) // False\ns.isBefore(d) // False\ns.isBetween(start, end, inclusive?) // True\n\n// Comparison by unit\ns.isSame(d, 'year') // True\ns.isSame(d, 'date') // False\ns.diff(d, 'day') // 5\ns.diff(d, 'month') // 0\n\n//make a human-readable diff\nlet before = spacetime([2018, 3, 28])\nlet now = spacetime([2017, 3, 28]) //one year later\nnow.since(before)\n// {diff: { months: 11, days: 30, ...}, rounded: 'in 12 months' }\n```\n\nall comparisons are done with sensitivity of timezone - **_8am EST_** is < **_8am PST_**.\n\n\n\n### Timezones:\n\nthe best way to describe a timezone is an [IANA code](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones):\n\n```js\n// Roll into a new timezone, at the same moment\ns = s.goto('Australia/Brisbane')\n```\n\nif you want to support relaxed timezone names like `'EST'`, `Eastern time`, use [timezone-soft](https://github.com/spencermountain/timezone-soft/)\n\n```js\nspacetime.extend(require('timezone-soft'))\n\ns = s.goto('milwaukee') // 'America/Chicago'\ns = s.goto('-7h') // UTC-7\ns = s.goto('GMT+8') // -8h!\n// (these should be used with some caution)\n```\n\nplay-around with timezones, and their DST-changes:\n\n```js\n//list timezones by their current time\nspacetime.whereIts('8:30pm', '9:30pm') // ['America/Winnipeg', 'America/Yellowknife'... ]\nspacetime.whereIts('9am') //(within this hour)\n\n// Timezone metadata\ns.timezone().name // 'Canada/Eastern' (either inferred or explicit)\ns.hemisphere() // North\ns.timezone().current.offset // -4 (in hours)\ns.hasDST() // True\ns.isDST() // True\n\n//list all timezones\nspacetime.timezones()\n```\n\nyou can flip-around the world pretty quick.\n\nspacetime will use your local timezone, by default:\n\n`.goto(null)` will pluck your current tz safely from your browser or computer.\n\n```js\nspacetime().time('4:30pm').goto('Europe/Paris').goto(null).time()\n// 4:30pm\n```\n\nIf, for some reason, you want to change the timezone *without changing the date*, you can do this via the `.timezone(str)` setter:\n```js\nlet s = spacetime('2023-01-01T5:30[America/Denver]')\ns = s.timezone('Europe/Zagreb') // hot-swap\nconsole.log(s.isoFull())\n// '2023-01-01T05:30:00.000+01:00[Europe/Zagreb]' (same time, new tz)\n```\n\n\n\n### Date Formatting:\n\nit's _[a pretty-sensible process](https://github.com/spencermountain/spacetime/wiki/Formatting)_ to create nice-looking dates:\n\n```js\n// Date + time formatting\ns.format('time') // '5:01am'\ns.format('numeric-uk') // 02/03/2017\ns.format('month') // 'April'\ns.format('month-short') // 'Apr'\ns.format('month-pad') // '03'\ns.format('iso-month') // '04'\n\n//if you want more complex formats, use {}'s\ns.format('{year}-{date-pad}-{month-pad}') // '2018-02-02'\ns.format(\"{hour} o'clock\") // '2 o'clock'\ns.format('{time}{ampm} sharp') // '2:30pm sharp'\n\n//if you prefer, you can also use unix-formatting\ns.unixFmt('yyyy.MM.dd h:mm a') // '2017.Nov.16 11:34 AM'\n\n// support for the new Temporal ISO format\ns.format('iso-full') // '2011-12-03T10:15:30.010+01:00[Europe/Paris]'\n\n// support for the SQL ISO 9075 format\ns.format('sql') // '2011-12-03 10:15:30'\n```\n\n\n\n\n\n![](\"https://user-images.githubusercontent.com/399657/68221632-b9094000-ffb7-11e9-99e0-b48edd6cdf8a.png\"/)
\n\n![](\"https://user-images.githubusercontent.com/399657/68221824-09809d80-ffb8-11e9-9ef0-6ed3574b0ce8.png\"/)
\n![](\"https://user-images.githubusercontent.com/399657/50862221-1d904a00-1369-11e9-891c-5f4e9fbb9ec0.gif\")
\n