https://github.com/thewisker/formatterjs
A javascript time and date formatter compatible with ES5 and ES6
https://github.com/thewisker/formatterjs
date es5 es6 formatter javascript module time
Last synced: 3 months ago
JSON representation
A javascript time and date formatter compatible with ES5 and ES6
- Host: GitHub
- URL: https://github.com/thewisker/formatterjs
- Owner: TheWisker
- License: gpl-3.0
- Created: 2022-12-11T09:33:00.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2022-12-12T18:53:23.000Z (over 2 years ago)
- Last Synced: 2025-02-07T17:54:25.760Z (4 months ago)
- Topics: date, es5, es6, formatter, javascript, module, time
- Language: JavaScript
- Homepage:
- Size: 3.71 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Javascript Date Formatter
Module that simplifies the formatting of dates
Installation
ES5
```bash
git clone https://github.com/TheWisker/FormatterJS
cd FormatterJS
cp -a ./out/ES5/classes/. ../destination/
cd ..
rm -fr FormatterJS
```
ES6
Node.js:
```bash
npm i @thewisker/formatterjs
```
Manually:
```bash
git clone https://github.com/TheWisker/FormatterJS
cd FormatterJS
cp -a ./out/ES6/module/. ../destination/
cd ..
rm -fr FormatterJS
```
This series of commands install the module to the destination folder. Use one or another depending on the ES version (5 or 6) with wich it will be executed.
`Note:`
· The ES6 version is up to 2 times faster.
· All installation scripts are located under the /scripts folder.
Importing
ES5
Just add a script tag refering to the `Formatter` file **before** any script tag that depends on it.
```html
```
ES6
With Node.js:
```js
import {UniversalFormatter, DateFormatter, TimeFormatter} from "@thewisker/formatterjs";
```
`Note: To run it with node.js name the file with the .mjs extension or add "type" : "module" to the package.json.`
Or manually, just add a import statement targeting the `Formatter` file with the classes to import between the brackets.
```js
import {UniversalFormatter, DateFormatter, TimeFormatter} from "/destination/Formatter.js";
```
`Note: All import examples are located under the /examples folder.`
Module Usage
Create a new instance of the desired formatter:
|Formatter|Constructor|Description|
|:-------:|:---------:|:----------|
|**`UniversalFormatter`**|`(Format: string, UTC: boolean)`|Formats date and time altogether|
|**`DateFormatter`**|`(Format: string, UTC: boolean)`|Formats only date|
|**`TimeFormatter`**|`(Format: string, UTC: boolean)`|Formats only time|
Then call the format function on the object and pass an optional date parameter.
|Function|Parameters|Default|Description|
|:------:|:--------:|:------|:----------|
|**`format`**|`(date: Date())`|`new Date()`|Formats the date object|
Formats
All the avaible formats equivalencies.
Misc
|Format|Type|Description|Example|
|:----:|:--:|:----------:|:----:|
|**`%%`**|`Escape Sequence`|Escapes the % character|%|
Date
|Format|Type|Description|Example|
|:----:|:--:|:----------:|:----:|
|**`%Y`**|`Year`|The year|2022|
|**`%y`**|`Year`|The short year|22 or 022|
|**`%J`**|`Year`|The day of the year|364|
|**`%M`**|`Month`|The month number|02|
|**`%m`**|`Month`|The month number|2|
|**`%B`**|`Month`|The month name|February|
|**`%b`**|`Month`|The month short name|Feb|
|**`%D`**|`Day`|The day of the month|08|
|**`%d`**|`Day`|The day of the month|8|
|**`%A`**|`Weekday`|The name of the day|Monday|
|**`%a`**|`Weekday`|The name of the day|Mon|
|**`%W`**|`Weekday`|The day of the week|1|
Time
|Format|Type|Description|Example|
|:----:|:--:|:----------:|:----:|
|**`%H`**|`Hour`|The hour in 24 format|20|
|**`%h`**|`Hour`|The hour in 24 format|20|
|**`%I`**|`Hour`|The hour in 12 format|08|
|**`%i`**|`Hour`|The hour in 12 format|08|
|**`%K`**|`Minutes`|The minutes|06|
|**`%k`**|`Minutes`|The minutes|6|
|**`%S`**|`Seconds`|The seconds|04|
|**`%s`**|`Seconds`|The seconds|4|
|**`%L`**|`Decisecond`|The decisecond|2|
|**`%Q`**|`Centisecond`|The centiseconds|02|
|**`%q`**|`Centisecond`|The centiseconds|2|
|**`%F`**|`Milisecond`|The miliszeconds|06|
|**`%f`**|`Milisecond`|The miliszeconds|6|
|**`%P`**|`Timestamp`|The timestamp|AM|
|**`%p`**|`Timestamp`|The timestamp|am|
|**`%f`**|`Timezone Offset`|The timezone offset|+02|
|**`%f`**|`Timezone Offset`|The timezone offset|+2|
Examples
```js
var Formatter = new UniversalFormatter("%Y %H"); //Formats the year and hour.
console.log(Formatter.format()); //Prints to console the format for the current Date() object.
```
`Output: 2020 12`
```js
var Formatter = new DateFormatter("%Y_%B"); //Formats the year and month.
console.log(Formatter.format(new Date("December 17, 1995 03:24:00"))); //Prints to console the format for the passed Date() object.
```
`Output: 1995_December`
```js
var Formatter = new TimeFormatter("(%H-%S)"); //Formats the hour and second.
console.log(Formatter.format(new Date("November 20, 1998 03:25:00"))); //Prints to console the format for the passed Date() object.
```
`Output: (03-25)`
`Note: All examples are located under the /examples folder.`
Compatibility
Under the `/out/{ES5, ES6}/function` folders a `Formatter.js` files is located containing a single function `format()` that can be used when compatibility issues arise when using classes.
|Function|Parameters|Default|Description|
|:------:|:--------:|:------|:----------|
|**`format`**|`(date: Date(), format: string, utc: boolean)`|No defaults|Formats the date object|
Author
TheWisker