permatime-parser: A JavaScript repository from timdiggins

Permatime-parser

A javascript parser for permatimes such as:

Practical permatime examples

http://permatime.com/US/Central/2008-12-04/11:00/37signals_live?link=http://live.37signals.com http://permatime.com/US/Central/2009-01-12/11:00/Next_teleconference

Historical permatimes

http://permatime.com/Europe/London/2012-07-27/12:00/Opening_Ceremony http://permatime.com/Europe/Berlin/1989-11-09/00:01/Berlin_wall http://permatime.com/US/Central/1963-11-22/12:30/Assassination_of_JFK

What is a permatime?

See http://www.permatime.com

Library usage

Optional dependency: to convert permatime URLs to timezone-aware moment instances, you need moment.js and moment-timezone installed. See http://momentjs.com/

Parsing

var parse = require('permatime-parser').parse;
var p = parse("http://permatime.com/Europe/London/2012-07-27/12:00/Opening_Ceremony"):
p.zone; // Europe/London
p.date; // 2012-07-27
p.time; // 12:00
p.label; // Opening_Ceremony

Construction

var Permatime = require('permatime-parser').Permatime;
var p = new Permatime({zone: 'Europe/London", date: "2012-07-27", time: "12:00"});

Use

// assume p is a permatime parsed or constructed as above, e.g.
var p = new Permatime({zone: 'Europe/London", date: "2012-07-27", time: "12:00"});

p.url(); // "http://permatime.com/Europe/London/2012-07-27/12:00"

p.moment(); // *a moment instance
p.toZone("Europe/London"); // *the same permatime

var p2 = p.toZone("Europe/Paris"); // *a new permatime
p2.url(); // "http://permatime.com/Europe/Paris/2012-07-27/13:00"

*Permatime.moment() and toZone() raise an error unless you have moment.js and moment timezone (optional dependencies) installed.

Permatime URL reference

Constructing Permatime URLs from your own application or even by hand is easy. They have five parts:

Host: permatime.com
Location: Europe/Berlin(See all)
Date: 1976-12-01 (Note that you need leading zeros for single digit months/days)
Time: 00:30 (Again you need leading zeros for single digit hours/minutes)
Optional label: My_Label
Optional link: ?link=http://myblog.com

Full url: http://permatime.com/Europe/Berlin/1976-12-01/00:30/My_Label?link=http://myblog.com

You can also use unix time stamps in a Permatime URL:

Host: permatime.com
Timestamp: timestamp/1226183760
Optional label: My_Label

Full url: http://permatime.com/timestamp/1226183760/My_Label

Development

you need git, npm etc.

git clone ...
npm install
npm test

timdiggins/permatime-parser