date-helper

JavaScript date helper

Still in development. Currently supports only getting formated date.

Instalation

$3

"date-helper-util": "x.y.z"

Usage

``
var dateHelper = require("date-helper-util");
`

$3

`
var date = new Date(2015, 1, 3);
date = dateHelper(date);
date.getFormated("DD/MM/YYYY"); // outputs 03/02/2015
`

$3

`
date = dateHelper("03/02/2015", "DD/MM/YYYY");
date.getFormated("YYYY/MM/DD"); // outputs 2015/02/03
`

Formats

- DD - date, if less then 10 prepends with 0
- D - date, if less then 10 NOT prepended with 0
- MMM - month as a month name (January, February, ...)
- MM - month, if less then 10 prepends with 0
- M - month, if less then 10 NOT prepended with 0
- YYYY - full year

Setting date values

`
var date = dateHelper(new Date());
`

$3

`
date.setYear(2016);
`

$3

`
date.setMonth(1); // accepts 1-12
`

$3

`
date.setDate(1);
`

Getting date values

Getting year

`
date.getYear();
`

Getting month

Returns values 1-12 and not like native JavaScript 0-11
`
date.getMonth();
`

Getting date

`
date.getDate();
`

Adding values to date

Values can be added by calling .add function with type and amount parameters. Type is string day, month or year.
`
date = dateHelper(new Date());
date.add("day", 1);
date.add("month", 1);
date.add("year", 1);
`

Subtracting values to date

Values can be subtracted by calling .sub function with type and amount parameters. Type is string day, month or year.
`
date = dateHelper(new Date());
date.sub("day", 1);
date.sub("month", 1);
date.sub("year", 1);
`

$3

isBefore function can be used to check if date is before other.
`
var date = new Date(2016, 4, 3);
dateHelper(date).isBefore(new Date(2016, 4, 4)); // true
`

$3

isAfter function can be used to check if date is after other.
`
var date = new Date(2016, 4, 3);
dateHelper(date).isAfter(new Date(2016, 4, 2)); // true
`

$3

isSameAs function can be used to check if date at same time as other.
`
var date = new Date(2016, 4, 3);
dateHelper(date).isSameAs(new Date(2016, 4, 3)); // true
`

$3

By using configuration month names can be set

#### Node module
`
var dateHelperConfig = require("../dev/dateHelper").config;
dateHelperConfig.setMonthNames(["Sijecan", "Veljaca", "Ozujak", "Travanj",
"Svibanj", "Lipanj", "Srpanj", "Kolovoz", "Rujan", "Listopad", "Studeni", "Prosinac"])
var date = new Date(2016, 4, 3);
dateHelper(date).getFormated("DD/MMM/YYYY"); // "03/Svibanj/2016"
`

#### Browser
`
dateHelper.config.setMonthNames(["Sijecan", "Veljaca", "Ozujak", "Travanj",
"Svibanj", "Lipanj", "Srpanj", "Kolovoz", "Rujan", "Listopad", "Studeni", "Prosinac"])
var date = new Date(2016, 4, 3);
dateHelper(date).getFormated("DD/MMM/YYYY"); // "03/Svibanj/2016"
``

TODO

- Tests
- Hours, minutes and seconds