@pmjonesg/date-fns-timezone
    TypeScript icon, indicating that this package has built-in type declarations

    0.0.2 • Public • Published

    date-fns-timezone

    NPM version Build Status Coverage Status Codacy Badge Dependency Status devDependency Status JavaScript Style Guide

    Provides parsing and formatting date strings and time zone conversions supporting IANA time zones, following the design of functions in date-fns. List of canonical time zone names is provided by @pmjonesg/timezone-support.

    Table of Contents

    Synopsis

    const { listTimeZones } = require('@pmjonesg/timezone-support')
    const { parseFromTimeZone, formatToTimeZone } = require('date-fns-timezone')
    
    // List canonical time zone names: [ 'Africa/Abidjan', ... ]
    const timeZones = listTimeZones()
    
    // Set the date to "2018-09-01T16:01:36.386Z"
    const date = parseFromTimeZone('2018-09-01 18:01:36.386', { timeZone: 'Europe/Berlin' })
    
    // Set the output to "1.9.2018 18:01:36.386 GMT+02:00 (CEST)"
    const date = new Date('2018-09-01Z16:01:36.386Z')
    const format = 'D.M.YYYY HH:mm:ss.SSS [GMT]Z (z)'
    const output = formatToTimeZone(date, format, { timeZone: 'Europe/Berlin' })

    Installation and Getting Started

    This module can be installed in your project using NPM or Yarn. Make sure, that you use Node.js version 6 or newer.

    $ npm i date-fns-timezone --save
    $ yarn add date-fns-timezone

    Functions are exposed as named exports from the package modules, for example:

    const { parseFromTimeZone, formatToTimeZone } = require('date-fns-timezone')

    You can read more about the module loading in other environments, like with ES6 or in web browsers. Usage scenarios demonstrate applications of this library in typical real-world scenarios. The API reference lists all functions with a description of their functionality.

    Contributing

    In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.

    Release History

    • 2018-10-10 v0.1.4 Fix compatibility with IE. Thanks, Andrii!
    • 2018-10-06 v0.1.2 Add TypeScript export declarations.
    • 2018-09-19 v0.1.0 Add parseString without a time zone to cover a gap in date-fns
    • 2018-09-17 v0.0.1 Initial release

    License

    Copyright (c) 2018 Ferdinand Prantl

    Licensed under the MIT license.

    Install

    npm i @pmjonesg/date-fns-timezone

    DownloadsWeekly Downloads

    1

    Version

    0.0.2

    License

    MIT

    Unpacked Size

    31.3 kB

    Total Files

    16

    Last publish

    Collaborators

    • pmjonesg