Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hexagon/minitz
Minimal utility to convert to or from any timezone. Deno/Node/Browser. ESM/CommonJS.
https://github.com/hexagon/minitz
commonjs-modules date es-module esm javascript time timezone-conversion typescript
Last synced: about 1 month ago
JSON representation
Minimal utility to convert to or from any timezone. Deno/Node/Browser. ESM/CommonJS.
- Host: GitHub
- URL: https://github.com/hexagon/minitz
- Owner: Hexagon
- License: mit
- Created: 2022-09-07T20:37:57.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-12-03T19:25:58.000Z (about 1 year ago)
- Last Synced: 2024-10-30T01:43:10.230Z (about 2 months ago)
- Topics: commonjs-modules, date, es-module, esm, javascript, time, timezone-conversion, typescript
- Language: JavaScript
- Homepage: http://minitz.56k.guru/
- Size: 961 KB
- Stars: 22
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: docs/contributing.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# minitz
[](https://github.com/Hexagon/minitz/actions/workflows/node.js.yml) [](https://github.com/Hexagon/minitz/actions/workflows/deno.yml)
[](https://badge.fury.io/js/minitz) [](https://www.npmjs.org/package/minitz) [](https://www.jsdelivr.com/package/gh/hexagon/minitz) [](https://www.codacy.com/gh/Hexagon/minitz/dashboard?utm_source=github.com&utm_medium=referral&utm_content=Hexagon/minitz&utm_campaign=Badge_Grade)
[](https://github.com/Hexagon/minitz/blob/main/LICENSE)
Minitz offers an efficient way to manage and manipulate time zone in native JavaScript Date objects. With a modern ES-module design and full typings, minitz is compatible with any environment that supports JavaScript or TypeScript. Highlights:
* Convert dates between any timezone supported by the system.
* Parses ISO8601 time strings.
* MIT licensed, use the library any way you want. For real.
* Minimal (less than 2 KB minified), no dependencies. Relies on JavaScript Intl and current best practices.
* Works in Node.js >=14.0 (both require and import).
* Works in Deno >=1.8.
* Works in Bun >=0.2.2
* Works in browsers as standalone, UMD or ES-module.
* Includes [TypeScript](https://www.typescriptlang.org/) typings.
Try Minitz live on [jsfiddle](https://jsfiddle.net/hexag0n/3mheu5by/)
Check out the full documentation at [minitz.56k.guru](https://minitz.56k.guru)
## Usage
While converting a Date object to another timezone in JavaScript is achievable using the Intl feature of vanilla JS, things can get complicated when you want to convert date/time from another timezone or between different timezones. See the following examples:
Vanilla js for converting **to** a specific time zone:
```javascript
// Get current time in Asia/Tokyo, using vanilla js
new Date().toLocaleString("sv-SE", { timeZone: "Asia/Tokyo" });
// -> 2022-09-15 17:23:45
```
Using minitz to convert **from** and **across** different time zones:
```javascript
// Get local time from time in Asia/Tokyo, using minitz and vanilla js
const localTime = minitz(2022,9,15,23,0,0,"Asia/Tokyo")
console.log( localTime.toLocaleString("sv-SE") );
// -> 2022-09-15 16:00:00
```
```javascript
// Get time in America/New_York from time in Asia/Tokyo, using minitz and vanilla js
// Also demonstrates that it's possible to use ISO8601 strings as input to minitz,
// through `.fromTZISO`
const localTime = minitz.fromTZISO("2022-09-15 23:00:00","Asia/Tokyo");
console.log( localTime.toLocaleString("sv-SE", { timeZone: "America/New_York" }) );
// -> 2022-09-15 10:00:00
```
## Installation
Details on installation for various platforms, including Node.js, Deno, Bun, and browsers, can be found in the [full documentation](https://minitz.56k.guru). A few installation commands are:
Node.js: `npm install minitz`
Deno: `import minitz from "https://deno.land/x/[email protected]/src/minitz.js";`
Bun: `bun add minitz`
For CDN, refer to the documentation.
## Contributing
Any contributions are welcome. See the [Contribution guide](https://minitz.56k.guru/contributing.html) to get started.
## Donations
If you found this library helpful and wish to support its development, consider making a donation through [Hexagon's GitHub Sponsors page](https://github.com/sponsors/hexagon). Your generosity ensures the library's continued development and maintenance.
## License
MIT