timezone-convert

Convert between timezone formats

timezone-convert

• timezone-convert
  • Overview
    • Important notes
      • Imperfect accuracy
      • Partial 'etcetera' and 'backward' zones for IANA
  • Features
  • Usage
    • CLI
    • Programatic
      • Install package
      • Import & use:
  • License

Overview

timezone-convert is a small and efficient utility library and CLI for (smart parsing and) converting between timezone formats.

Important notes

Imperfect accuracy

The primary goal of the project is to focus on converting from one timezone format into a roughly accurate representation in other formats for possible of use with other libraries (e.g Windows display name from calendar => TZID / IANA for datetime manipulation), and AS SIMPLE AS POSSIBLE, things like extensive array mapping (Windows id => Multiple IANA ids) won't be available.

Partial 'etcetera' and 'backward' zones for IANA

The project will only supports the ETC IANA ids that is also used by Windows, and only supports the commonly-used backward IANA ids (like America/Indianapolis), uncommon ids like WET, W-SU is not supported, but in a fast-check, this library should support a few more commonly-used ids than windows-iana.

Features

• Parsing and converting between:
  • Windows display name
  • Windows time zone id
  • IANA (Olsen) tzdb ids
• Auto parse from any formats, just parseTzAuto(str)

Usage

CLI

npx timezone-convert "Europe/Athens"
# Outputs a JSON string of the parsed timezone
# { iana, windowsId, windowsDisplay }

# Example use with `jq`
npx -y timezone-convert Asia/Saigon | jq '.windowsDisplay'
Copy

Programatic

Install package

# npm
npm install timezone-convert

# bun
bun add timezone-convert

# pnpm (recommended)
pnpm install timezone-convert
Copy

Import & use:

// ESM
import { parseTzAuto } from 'timezone-convert'

const bucharestTz = parseTzAuto('Europe/Bucharest')
Copy

License