@shopify/dates - npm Package Compare versions

Comparing version 0.2.0 to 0.2.1

package.json

 {
   "name": "@shopify/dates",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "license": "MIT",
@@ -30,3 +30,3 @@ "description": "Lightweight date operations library.",
   "devDependencies": {
-    "@shopify/jest-dom-mocks": "^2.7.7"
+    "@shopify/jest-dom-mocks": "^2.8.0"
   },
@@ -33,0 +33,0 @@ "files": [

README.md

@@ -81,2 +81,72 @@ # `@shopify/dates`
 
+### `isLessThanOneDayAgo`
+
+Takes in a date object and an optional "now" date object (that defaults to `new Date()`). Returns a boolean indicating whether or not the date is less than one day before the "now" date.
+
+```ts
+import {isLessThanOneDayAgo} from '@shopify/dates';
+
+const moreThanOneDayAgo = new Date('2018-01-01Z00:00');
+const lessThanOneDayAgo = new Date(Date.now() - 23 * TimeUnit.Hour);
+
+isLessThanOneDayAgo(moreThanOneDayAgo); // false
+isLessThanOneDayAgo(lessThanOneDayAgo); // true
+```
+
+### `isLessThanOneHourAgo`
+
+Takes in a date object and an optional "now" date object (that defaults to `new Date()`). Returns a boolean indicating whether or not the date is less than one hour before the "now" date.
+
+```ts
+import {isLessThanOneHourAgo} from '@shopify/dates';
+
+const moreThanOneHourAgo = new Date('2018-01-01Z00:00');
+const lessThanOneHourAgo = new Date(Date.now() - 59 * TimeUnit.Minute);
+
+isLessThanOneHourAgo(moreThanOneHourAgo); // false
+isLessThanOneHourAgo(lessThanOneHourAgo); // true
+```
+
+### `isLessThanOneMinuteAgo`
+
+Takes in a date object and an optional "now" date object (that defaults to `new Date()`). Returns a boolean indicating whether or not the date is less than one minute before the "now" date.
+
+```ts
+import {isLessThanOneMinuteAgo} from '@shopify/dates';
+
+const moreThanOneMinuteAgo = new Date('2018-01-01Z00:00');
+const lessThanOneMinuteAgo = new Date(Date.now() - 59 * TimeUnit.Second);
+
+isLessThanOneMinuteAgo(moreThanOneMinuteAgo); // false
+isLessThanOneMinuteAgo(lessThanOneMinuteAgo); // true
+```
+
+### `isLessThanOneWeekAgo`
+
+Takes in a date object and an optional "now" date object (that defaults to `new Date()`). Returns a boolean indicating whether or not the date is less than one week before the "now" date.
+
+```ts
+import {isLessThanOneWeekAgo} from '@shopify/dates';
+
+const moreThanOneWeekAgo = new Date('2018-01-01Z00:00');
+const lessThanOneWeekAgo = new Date(Date.now() - 6 * TimeUnit.Day);
+
+isLessThanOneWeekAgo(moreThanOneWeekAgo); // false
+isLessThanOneWeekAgo(lessThanOneWeekAgo); // true
+```
+
+### `isLessThanOneYearAgo`
+
+Takes in a date object and an optional "now" date object (that defaults to `new Date()`). Returns a boolean indicating whether or not the date is less than one year before the "now" date.
+
+```ts
+import {isLessThanOneYearAgo} from '@shopify/dates';
+
+const moreThanOneYearAgo = new Date('2018-01-01Z00:00');
+const lessThanOneYearAgo = new Date(Date.now() - 51 * TimeUnit.Week);
+
+isLessThanOneYearAgo(moreThanOneYearAgo); // false
+isLessThanOneYearAgo(lessThanOneYearAgo); // true
+```
+
 ### `isSameDay`
@@ -83,0 +153,0 @@

Fixed alerts

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Improved metrics

Number of lines in readme file

292

increased by31.53%

Number of medium supply chain risk alerts

0

decreased by-100%

Worsened metrics

Total package byte prevSize

37911

decreased by-6.7%

Number of package files

51

decreased by-32%

No dependency changes