# mcfly-timezone > Changes deprecated timezone strings into modern IANA Olsen Timezone equivalents. Latest version **1.1.1** (published 2018-01-02) · Apache-2.0 license · 0 weekly downloads ## Install ```sh npm install mcfly-timezone pnpm add mcfly-timezone yarn add mcfly-timezone bun add mcfly-timezone ``` ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 1.1.1 | | Published | 2018-01-02 | | First published | 2016-08-11 | | Weekly downloads | 0 | | License | Apache-2.0 | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 4 | | Known vulnerabilities | 0 (+2 in 1 direct dependencies) | | Install scripts | no | | GitHub stars | 1 | | Author | Tristan Davey | | Maintainers | tjdavey, safetyculture | | Keywords | timezone, timezones, zoneinfo, tzdata, tz, olson, iana, deprecated, backward, historical, old, convert, conversion, modernise, modern | ## Links - npm: https://www.npmjs.com/package/mcfly-timezone - Repository: https://github.com/SafetyCulture/mcfly - Homepage: https://github.com/SafetyCulture/mcfly#readme - Issues: https://github.com/SafetyCulture/mcfly/issues - npm.io page: https://npm.io/package/mcfly-timezone ## Dependencies (4) - [async](https://npm.io/package/async.md) ^0.9.0 - [csv-parse](https://npm.io/package/csv-parse.md) ^0.1.4 - [coffee-script](https://npm.io/package/coffee-script.md) ^1.10.0 - [stream-transform](https://npm.io/package/stream-transform.md) 0.0.7 ## Alternatives - [@js-joda/timezone](https://npm.io/package/@js-joda/timezone.md) — 383.4K weekly downloads - [chartjs-adapter-moment](https://npm.io/package/chartjs-adapter-moment.md) — 210.8K weekly downloads - [strftime](https://npm.io/package/strftime.md) — 171.2K weekly downloads - [vue-flatpickr-component](https://npm.io/package/vue-flatpickr-component.md) — 115.8K weekly downloads - [timepicker](https://npm.io/package/timepicker.md) — 51.0K weekly downloads ## Recent versions - 1.1.1 (latest) — 2018-01-02 - 1.2.0-alpha.1 — 2017-12-27 - 1.1.0 — 2016-08-11 - 1.0.0 — 2016-08-11 ## README __---~~~~--__ __--~~~~---__ `\---~~~~~~~~\\ //~~~~~~~~---/' \/~~~~~~~~~\|| ||/~~~~~~~~~\/ `\\ //' `\\ //' || || Hey Doc! ______--~~~~~~~~~~~~~~~~~~--______ ___ // _-~ ~-_ \\ ___ `\__)\/~ ~\/(__/' _--`-___ ___-'--_ /~ `\ ~~~~~~~~------------~~~~~~~~ /' ~\ /| `\ ________ /' |\ | `\ ______`\_ \------/ _/'______ /' | | `\_~-_____\ ~-________________-~ /_____-~_/' | `. ~-__________________________________-~ .' `. [_______/------|~~|------\_______] .' `\--___((____)(________\/________)(____))___--/' |>>>>>>|| ||<<<<<<| `\<<<<>>>>/' # McFly [![Build Status](https://travis-ci.org/SafetyCulture/McFly.svg?branch=master)](https://travis-ci.org/SafetyCulture/McFly) [![Coverage Status](https://coveralls.io/repos/github/SafetyCulture/McFly/badge.svg?branch=master)](https://coveralls.io/github/SafetyCulture/McFly?branch=master) ## Purpose and Intent McFly provides a convenient mechanism to modernise obsolete or deprecated Olson/IANA timezone strings into their modern equivalent timezone string. Example: `Asia/Saigon` -> `Asia/Ho_Chi_Minh` ## Installation Install via NPM npm install mcfly-timezone ### Conversions McFly, by default, utilises the 'backward' database, part of the larger IANA Timezone Database which is available under a Public Domain license. This will convert all deprecated timezone strings which have at any time formed a part of the IANA or Olson Timezone Databases to their modern equivalent. Included 'Backward' Version: **2017b** McFly is designed to ingest 'link' files provided by IANA as part of their Timezone Database which are used to alias one timezone string to another timezone string. You can provide other link files from the IANA data files using the custom configuration options below. ## Usage Require the McFly module and call the `convert` method passing in the `oldTimezoneString`, a set of `options` (optional) and a `callback` to be called on completion. If the given timezone string has a valid conversion it will be converted to the new format, if not the original string will be returned. ### Arguments * `oldTimezoneString` - A timezone string to be converted * `options` - A set of options to configure the conversion of timezone strings (optional). See below for the available options. If not given the default options will be used. * `callback` - A callback which is called when the conversion is complete #### Options * `conversions` - A file or directory path to the IANA TZ DB Link file/files OR an object where keys are deprecated timezone strings where the value corresponds to their linked target string. Default: `"/conversions"` * `ignore` - A regular expression defining any old timezone strings which should be ignored for conversion. Default: `null` ### Example #### Using default options mcFly.convert("Asia/Saigon", function(error, result){ \\ Output Asia/Ho_Chi_Minh console.log(result); }) #### Using custom options options = { conversions: { 'Europe/Belfast': 'Europe/London', 'GB': 'Europe/London', 'GB-Eire': 'Europe/London' }, ignore: /\// } mcFly.convert("Europe/Belfast", options, function(error, result){ \\ Output Europe/Belfast console.log(result); }) mcFly.convert("GB", options, function(error, result){ \\ Output Europe/London console.log(result); }) #### Limitations * McFly only converts timezone strings known to conform to a given format which have a valid current equivalent. The IANA Timezone Database maintains a list of known historical, obsolete and obscure Timezones which are not covered by the database. Timezone representations which have never formed part of the IANA or Olson databases are also unsupported. ## Caveats * When using conversions loaded from a file these are cached in-memory for the lifetime of the module's life in memory. This means changes to the state of conversions of the filesystem may not be updated unless the module is re-imported or the `_conversionCache` property on the module root is cleared. --- _Source: https://npm.io/package/mcfly-timezone · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._