workdate
v0.0.5
Published
Allows returning a date in a given format.
Downloads
8
Maintainers
Readme
NodeJS WorkDate
A npm package is developed that allows you to return a date in a certain format.
NPM Package: https://www.npmjs.com/package/workdate
Function format
Description
string require('workDate').format( string format [, (string, array, int) settings ] );
Parameters
format
The format of the outputted date string. See the formatting options below
| format character | Description | Example returned values | | --- | --- | --- | | Day | -- | -- | | d | Day of the month, 2 digits with leading zeros | 01 to 31 | | D | A textual representation of a day, three letters | Mon through Sun | | j | Day of the month without leading zeros | 1 to 31 | | l (lowercase 'L') | A full textual representation of the day of the week | Sunday through Saturday | | N | ISO-8601 numeric representation of the day of the week | 1 (for Monday) through 7 (for Sunday) | | w | Numeric representation of the day of the week | 0 (for Sunday) through 6 (for Saturday) | | z | The day of the year (starting from 0) | 0 through 365 | | Week | -- | -- | | W | ISO-8601 week number of year, weeks starting on Monday | Example: 42 (the 42nd week in the year) | | Month | -- | -- | | F | A full textual representation of a month, such as January or March | January through December | | m | Numeric representation of a month, with leading zeros | 01 through 12 | | M | A short textual representation of a month, three letters | Jan through Dec | | n | Numeric representation of a month, without leading zeros | 1 through 12 | | Year | -- | -- | | L | Whether it's a leap year | 1 if it is a leap year, 0 otherwise. | | Y | A full numeric representation of a year, 4 digits | Examples: 1999 or 2003 | | y | A two digit representation of a year | Examples: 99 or 03 | | Time | -- | -- | | a | Lowercase Ante meridiem and Post meridiem | am or pm | A | Uppercase Ante meridiem and Post meridiem | AM or PM | B | Swatch Internet time | 000 through 999 | g | 12-hour format of an hour without leading zeros | 1 through 12 | G | 24-hour format of an hour without leading zeros | 0 through 23 | h | 12-hour format of an hour with leading zeros | 01 through 12 | H | 24-hour format of an hour with leading zeros | 00 through 23 | i | Minutes with leading zeros | 00 to 59 | s | Seconds, with leading zeros | 00 through 59 | u | Microseconds. | Example: 654321 | v | Milliseconds. Same note applies as for u. | Example: 654 | U | Seconds since the Unix Epoch (January 1 1970 00:00:00 GMT) | | | Timezone | -- | -- | | e | Timezone identifier | Examples: UTC, GMT, Atlantic/Azores | I | Whether or not the date is in daylight saving time | 1 if Daylight Saving Time, 0 otherwise. | O | Difference to Greenwich time (GMT) in hours | Example: +0200 | P | Difference to Greenwich time (GMT) with colon between hours and minutes | Example: +02:00 | T | Timezone abbreviation | Examples: EST, MDT ... | Z | Timezone offset in seconds. The offset for timezones west of UTC is always negative, and for those east of UTC is always positive. | -43200 through 50400 | Full Date/Time | -- | -- | | c | ISO 8601 date | 2004-02-12T15:19:21+00:00 | r | RFC 2822 formatted date | Example: Thu, 21 Dec 2000 16:01:07 +0200
settings
The optional settings parameter is an integer Unix that defaults to the current local time if a timestamp is not given.
Examples
Example 1
To get the date in the format D, d M Y H:i:s You must specify the first parameter of the format Tue, 28 Au 2018 22:51:04
const workDate = require('./workDate');
console.log(
workDate.format('H:i:s d/m/Y'), '\n',
workDate.format('l jS \of F Y h:i:s A'), '\n',
workDate.format('l'), '\n',
workDate.format('l j'),
);
Example 2
console.log( workDate.format("F j, Y, g:i a") ); // March 10, 2001, 5:16 pm
console.log( workDate.format("m.d.y") ); // 03.10.01
console.log( workDate.format("j, n, Y") ); // 10, 3, 2001
console.log( workDate.format("Ymd") ); // 20010310
console.log( workDate.format('h-i-s, j-m-y, it is w Day') ); // 05-16-18, 10-03-01, 1631 1618 6 Satpm01
console.log( workDate.format("D M j G:i:s T Y") ); // Sat Mar 10 17:16:18 MST 2001
console.log( workDate.format("H:i:s") ); // 17:16:18
console.log( workDate.format("Y-m-d H:i:s") ); // 2001-03-10 17:16:18 (the MySQL DATETIME format)
Function strToTime
Description
string require('workDate').strToTime( string time [, int now ] );
The function expects to be given a string containing an English date format and will try to parse that format into a Unix timestamp (the number of seconds since January 1 1970 00:00:00 UTC), relative to the timestamp given in now, or the current time if now is not supplied.
Parameters
text
A date/time string. Valid formats are explained in Date and Time Formats.
now
The timestamp which is used as a base for the calculation of relative dates.
Returns
Returns a timestamp on success.
Examples
console.log( workDate.strToTime() );
console.log( workDate.strToTime('now') );
console.log( workDate.strToTime('10 September 2000') );
console.log( workDate.strToTime('+1 day') );
console.log( workDate.strToTime('+1 week') );
console.log( workDate.strToTime('+1 week 2 days 4 hours 2 seconds') );
console.log( workDate.strToTime('next Thursday') );
console.log( workDate.strToTime('last Monday') );