Daniel Legt 5eac2dc1e2 | ||
---|---|---|
dist | ||
src | ||
.gitignore | ||
.npmignore | ||
CONTRIBUTING.md | ||
README.md | ||
jestconfig.json | ||
license | ||
package-lock.json | ||
package.json | ||
tsconfig.json |
README.md
Tyme.js
Site | Docs/Wiki | Contributing |
Building the project yourself:
$ git pull https://github.com/JustKato/Tyme.js tymejs
$ cd tymejs
$ npm run build
Download
Tyme.js is released under the MIT license & supports modern environments.
Installation
In a browser:
<script src="tyme.js"></script>
Using npm:
$ npm i tymejs
Usage
All of the available formats are directly from PHP's date formats
⚠ Warning ⚠
⚠ Not all different character formats have been implemented. ⚠
In Node.js TypeScript:
// Import the Package
import TymeJS from "tymejs"; // Use require for plain javascript
// Get the date object from Somewhere
let myDate: Date = new Date();
// Initialize the TymeJS Object
let t: TymeJS = new TymeJS(myDate);
// Now you can format different dates
let formattedDate: string = t.format("d/m/Y H:i A");
// All Available formats: https://www.php.net/manual/en/datetime.format.php#refsect1-datetime.format-parameters
// Log the formatted Date
console.log(formattedDate);
In Node.js using JavaScript:
const { default: TymeJS } = require("tymejs");
// Get the date object from Somewhere
let myDate = new Date();
// Initialize the TymeJS Object
let t = new TymeJS(myDate);
// Now you can format different dates
let formattedDate = t.format("d/m/Y H:i A");
// All Available formats: https://www.php.net/manual/en/datetime.format.php#refsect1-datetime.format-parameters
// Log the formatted Date
console.log(formattedDate);
Why TymeJS?
TymeJS makes working with JavaScript date objects much easier, I've found myself
multiple times in the situation where the client doesn't like their region's date format
and requests for custom formats, this consumed a lot of time implementing, so that's why
I have created this library, for:
- Reliable Date formats
- Reliable Time formats
- TypeScript Support