@date-fns/utc - npm Package Compare versions

Comparing version 0.5.5 to 1.0.0

date/index.js

@@ -72,3 +72,3 @@ "use strict";
 });
-var timeFormat = new Intl.DateTimeFormat("en-US", {
+var timeFormat = new Intl.DateTimeFormat("en-GB", {
   hour12: false,
@@ -75,0 +75,0 @@ hour: "numeric",

package.json

 {
   "name": "@date-fns/utc",
-  "version": "0.5.5",
+  "version": "1.0.0",
   "description": "UTC date utils",
@@ -5,0 +5,0 @@ "scripts": {

README.md

@@ -1,3 +0,69 @@
-# date-fns UTC utils
+# @date-fns/utc
 
-🚧 Work in progress
+The package provides `Date` extensions `UTCDate` and `UTCDateMini` that perform
+all calculations in UTC rather than the system time zone.
+
+Using it makes [date-fns] operate in UTC but can be also used without it.
+
+## Installation
+
+```bash
+npm install @date-fns/utc --save
+```
+
+## Usage
+
+`UTCDate` and `UTCDateMini` have API identical to `Date`, but perform all calculations in UTC, which might be essential when calculating abstract date-time, i.e for rendering chart or calendar component:
+
+```ts
+import { UTCDate } from "@date-fns/utc";
+import { addHours } from "date-fns";
+
+// Given that the system time zone is America/Los_Angeles
+// where DST happens at Sunday, 13 March 2022, 02:00:00
+
+// Using system time zone will produce 03:00 instead of 02:00 because of DST:
+const date = new Date(2022, 2, 13);
+addHours(date, 2).toString();
+//=> 'Sun Mar 13 2022 03:00:00 GMT-0700 (Pacific Daylight Time)'
+
+// Using UTC will provide expected 02:00:
+const utcDate = new UTCDate(2022, 2, 13);
+addHours(utcDate, 2).toString();
+//=> 'Sun Mar 13 2022 02:00:00 GMT+0000 (Coordinated Universal Time)'
+```
+
+### Difference between `UTCDate` and `UTCDateMini`
+
+Unlike `UTCDateMini` which implements only getters, setters, and
+`getTimezoneOffset`, `UTCDate` also provides formatter functions, mirroring
+all original `Date` functionality:
+
+```ts
+import { UTCDateMini, UTCDate } from "@date-fns/utc";
+
+// UTCDateMini will format date-time in the system time zone:
+new UTCDateMini(2022, 2, 13).toString();
+//=> 'Sat Mar 12 2022 16:00:00 GMT-0800 (Pacific Standard Time)'
+
+// UTCDate will format date-time in the UTC, like expected:
+new UTCDate(2022, 2, 13).toString();
+//=> 'Sun Mar 13 2022 00:00:00 GMT+0000 (Coordinated Universal Time)'
+```
+
+Even though `UTCDate` has a complete API, developers rarely use the formatter
+functions outside of debugging, so we recommend you pick the more lightweight
+`UTCDateMini` for internal use. However, in environments you don't control,
+i.e., when you expose the date from a library, using `UTCDate` will be
+a safer choice.
+
+For instance, in date-fns locale functions (`format`, `parse`, etc.), we use
+`UTCDateMini` to ensure the minimal build size.
+
+## Changelog
+
+See [the changelog](./CHANGELOG.md).
+
+## License
+
+[MIT © Sasha Koss](https://kossnocorp.mit-license.org/)

Fixed alerts

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

11076

30.61%

Number of package files

12

9.09%

Number of low quality alerts

0

-100%

Number of lines in readme file

70

1650%

No dependency changes