Table of Contents

• About the Project
• Getting Started
• Usage
• Contributing
• License
• Contact
• Acknowledgements

About The Project

The built in support for iso8601 date/times does not include any timezone offset formatting. This was the beginning of the project. The need to foramt a date/time string with offset.

Installation

With yarn

yarn add iso8601-support

With npm

npm install iso8601-support

Usage

import * as iso8601 from 'iso8601-support';

// Passing no argument uses the current time and local machine offset.
iso8601.toISOStringWithOffset();
// '2019-12-18T03:49:38.282-08:00'

// Passing a date in will use the local machine offset.
iso8601.toISOStringWithOffset(new Date('2018-04-01T00:00:00.000Z'));
// '2018-03-31T17:00:00.000-07:00' (if you're current local offset is UTC-7)

// Passing a date and offset will use that offset instead of the local one.
iso8601.toISOStringWithOffset(new Date('2018-03-31T23:00:00.000Z'), -120);
// '2018-04-01T01:00:00.000+02:00'

// Passing just an offset will use the local time with the given offset.
iso8601.toISOStringWithOffset(undefined, -600);
// '2020-01-08T05:49:41.428+10:00'

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

This filled a need I had but if you need some other part of the iso8601 spec, add it and open a PR.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Trevor Dorsey - @tsdorsey - [email protected]

Project Link: https://github.com/tsdorsey/iso8601-js

Acknowledgements

• Choose an Open Source License
• Img Shields
• TypeScript