protodate v3.0.8

v3.0.8

Better Javascript Dates.

Contents

• Intro
• Choose Your File
• Usage
• Formatting Dates
• Parsing Dates
• Manipulating Dates
• Converting Timezones
• Type Conversion
• Formatting Characters
• Timezone Reference
• License

Intro

ProtoDate is a very fast and lightweight solution for building, parsing, manipulating and formatting Javascript Dates. ProtoDate extends the native JS Date object (without modifying the original prototype) for ease of use and to keep the library light. By leveraging native, low-level code ProtoDate is able to achieve unprecedented speeds.

Compare ProtoDate to Moment.js:

Check out the benchmarks.

Also, if you happened to be a PHP developer, you're in luck because ProtoDate uses the same date formatting as PHP's native date function.

Choose Your File

ProtoDate has 6 different versions so you only have to download what you need.

• protodate.min.js
• protodate.js
• protodate.tz.min.js
• protodate.tz.js
• protodate.tz.full.js
• protodate.tz.full.min.js

Here's a helpful flow chart to help you choose which file best fits your needs:

Usage

Browsers:

Download and include the js file that best fits your needs and include it in your markup.

<script src='protodate.min.js'></script>

Node

Install the library with npm install protodate and require the file that best fits your needs in your script.

const ProtoDate = require('protodate.js');

Formatting Dates

Use the format(formatStr) method to format dates as strings. Use the Formatting Characters Table to build your format string.

Example: new ProtoDate().format("m/d/y g:i a")

Parsing Dates

Use the parse(dateStr[, formatStr]) method to create a ProtoDate object from a string. If you provide a format string to the method, parsing will be much faster, but ProtoDate is smart enough to guess just about any format without it. Use any of the parsable formatting characters to create a format string.

Example: Protodate.parse("January 3rd 2007 @ 4 o'clock")

Manipulating Dates

Use the plus(quantity, period) and minus(quantity, period) methods to add and subtract time from a Date instance.

The period parameter is the unit of time to add or subtract, and the quantity parameter is how many of them to add or subtract. Specify the period parameter with using one of the 6 Date Period Constants, (ie, ProtoDate.MILLISECOND, ProtoDate.SECOND, ProtoDate.MINUTE, ProtoDate.HOUR, ProtoDate.DAY, ProtoDate.YEAR).

Example: new ProtoDate().add(3, ProtoDate.DAY) // 3 days from now

Converting Timezones

This functionality is only available in the `protodate.tz.` files*

You can convert dates to other timezones with the setTimezone(timezone) method.

Example: new ProtoDate().setTimezone('Asia/Hong_Kong').toString() // Current time in Hong Kong

Type Conversion

Generally, you should never need to convert a ProtoDate object to a native Date object since ProtoDate extends Date - it has all the same methods, but these functions are provided as a convenience.

Converting ProtoDate to native Date

Example: const date = protodate.toDate();

Converting Date to ProtoDate

Example: const protodate = ProtoDate.fromDate(date);

Formatting Characters

Each character represents part of a date format string. Characters listed as Parsable are understood by the parse method. All other characters, as well as characters escaped with a \ in the format string will be printed as-is.

Timezone Reference

A list of timezones and their corresponding countries:

License

ProtoDate comes with an Apache 2.0 license. Read the license here.