@wistia/vhs 2.76.6-beta.591c20c1.7090971 → 2.76.6-beta.a5db6e89.f2049e2

package/dist/helpers/datetimeHelpers/datetimeHelpers.d.ts

@@ -1,8 +1,10 @@
 type DateOnlyStringOptions = {
     timeZone?: string;
+    omitYear?: boolean;
 };
 type TimeAgoOptions = {
     nowAnchor?: Date;
+    includeTime?: boolean;
 };
 type Duration = {
     seconds: number;
@@ -94,7 +96,7 @@ export declare const timeOnlyString: (date: unknown, { timeZone }?: DateOnlyStri
  * @param {string} options.timeZone - the timezone you want date displayed in, defaults to current users time zone
  * @returns {string} a formatted date string
  */
-export declare const dateTimeString: (date: Date | number | string | null | undefined, { timeZone }?: DateOnlyStringOptions) => string;
+export declare const dateTimeString: (date: Date | number | string | null | undefined, { timeZone, omitYear }?: DateOnlyStringOptions) => string;
 /**
  * Converts a Date object into a date and time string
  * for use in a sentence.
@@ -139,14 +141,27 @@ export declare const dateOnlyStringForSentence: (date: unknown, { timeZone }?: D
  *
  *   Feb 23, 2020, 1:55 PM
  *
+ *  or when `includeTime` is false:
+ *
+ *   Today
+ *
+ *   Yesterday
+ *
+ *   on Thursday
+ *
+ *   Nov 11
+ *
+ *   Feb 23, 2020
+ *
  * NOTE: timeAgoString doesn't support multiple time zones since doing so would
  * complicate calculations for whether to use "Today" or "Yesterday".
  * @param {Date} date - the date relative to now
  * @param {object} options -
  * @param {Date} options.nowAnchor - The date used to calculate relative to now. Defaults to current date but can be overwritten for tests.
+ * @param {boolean} options.includeTime - Whether to include the time in the output. Defaults to true.
  * @returns {string} - a string representation of the date.
  */
-export declare const timeAgoString: (date: Date, { nowAnchor }?: TimeAgoOptions) => string;
+export declare const timeAgoString: (date: Date, { nowAnchor, includeTime }?: TimeAgoOptions) => string;
 /**
  * Given a date, shows the UTC offset.
  * @param {Date} date a Date object for calculating offset.

package/dist/helpers/datetimeHelpers/datetimeHelpers.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"datetimeHelpers.d.ts","sourceRoot":"","sources":["../../../src/helpers/datetimeHelpers/datetimeHelpers.ts"],"names":[],"mappings":"AAGA,KAAK,qBAAqB,GAAG;IAC3B,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,KAAK,cAAc,GAAG;IACpB,SAAS,CAAC,EAAE,IAAI,CAAC;CAClB,CAAC;AAEF,KAAK,QAAQ,GAAG;IACd,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,KAAK,oBAAoB,GAAG;IAC1B,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAeF;;;GAGG;AACH,eAAO,MAAM,MAAM,GAAI,MAAM,OAAO,KAAG,IAAI,IAAI,IAA4B,CAAC;AAQ5E;;;;;;;;GAQG;AACH,eAAO,MAAM,cAAc,GACzB,MAAM,OAAO,EACb,eAAgC,qBAA0B,KACzD,MAcF,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,qBAAqB,GAChC,MAAM,OAAO,EACb,eAAgC,qBAA0B,KACzD,MAgBF,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,iBAAiB,GAC5B,MAAM,OAAO,EACb,eAAgC,qBAA0B,KACzD,MA0BF,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,qBAAqB,GAChC,MAAM,OAAO,EACb,eAAgC,qBAA0B,KACzD,MAeF,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,eAAe,GAC1B,MAAM,IAAI,GAAG,IAAI,EACjB,eAAgC,qBAA0B,KACzD,MAcF,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,cAAc,GACzB,MAAM,OAAO,EACb,eAAgC,qBAA0B,KACzD,MAcF,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,cAAc,GACzB,MAAM,IAAI,GAAG,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,SAAS,EAC/C,eAAgC,qBAA0B,KACzD,MAqBF,CAAC;AAEF;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,yBAAyB,GACpC,MAAM,OAAO,EACb,eAAgC,qBAA0B,KACzD,MA0BF,CAAC;AAEF;;;;;;;;;;GAUG;AACH,eAAO,MAAM,yBAAyB,GACpC,MAAM,OAAO,EACb,eAAgC,qBAA0B,KACzD,MAcF,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,eAAO,MAAM,aAAa,GACxB,MAAM,IAAI,EACV,gBAA4B,cAAmB,KAC9C,MA6CF,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,aAAa,GAAI,MAAM,IAAI,KAAG,MAS1C,CAAC;AAEF;;;;;GAKG;AACH;;;;;GAKG;AACH,eAAO,MAAM,iBAAiB,GAAI,sBAAsB,MAAM,KAAG,QAQhE,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,mBAAmB,GAAI,sBAAsB,MAAM,KAAG,MAQlE,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,qBAAqB,GAAI,sBAAsB,MAAM,KAAG,MAIpE,CAAC;AAEF;;;;;;;GAOG;AACH;;;GAGG;AACH,eAAO,MAAM,cAAc,GAAI,MAAM,IAAI,GAAG,IAAI,GAAG,SAAS,KAAG,oBAAoB,GAAG,IAYrF,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,cAAc,GACzB,UAAU,OAAO,CAAC,oBAAoB,CAAC,GAAG,IAAI,GAAG,SAAS,KACzD,IAAI,GAAG,IAOT,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,aAAa,GAAI,UAAU,OAAO,CAAC,oBAAoB,CAAC,KAAG,MAAM,GAAG,IAChC,CAAC;AAElD,KAAK,uBAAuB,GAAG;IAC7B,CAAC,QAAQ,EAAE,IAAI,EAAE,WAAW,CAAC,EAAE,IAAI,GAAG,MAAM,GAAG,IAAI,CAAC;IACpD,CAAC,QAAQ,EAAE,IAAI,EAAE,WAAW,EAAE,KAAK,GAAG,IAAI,GAAG,IAAI,CAAC;CACnD,CAAC;AAEF;;;;GAIG;AAGH,eAAO,MAAM,eAAe,EAAE,uBAgB7B,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,+BAA+B,GAAI,sBAAsB,MAAM,KAAG,MAsB9E,CAAC"}
+{"version":3,"file":"datetimeHelpers.d.ts","sourceRoot":"","sources":["../../../src/helpers/datetimeHelpers/datetimeHelpers.ts"],"names":[],"mappings":"AAIA,KAAK,qBAAqB,GAAG;IAC3B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB,CAAC;AAEF,KAAK,cAAc,GAAG;IACpB,SAAS,CAAC,EAAE,IAAI,CAAC;IACjB,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB,CAAC;AAEF,KAAK,QAAQ,GAAG;IACd,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,KAAK,oBAAoB,GAAG;IAC1B,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAeF;;;GAGG;AACH,eAAO,MAAM,MAAM,GAAI,MAAM,OAAO,KAAG,IAAI,IAAI,IAA4B,CAAC;AAQ5E;;;;;;;;GAQG;AACH,eAAO,MAAM,cAAc,GACzB,MAAM,OAAO,EACb,eAAgC,qBAA0B,KACzD,MAcF,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,qBAAqB,GAChC,MAAM,OAAO,EACb,eAAgC,qBAA0B,KACzD,MAgBF,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,iBAAiB,GAC5B,MAAM,OAAO,EACb,eAAgC,qBAA0B,KACzD,MA0BF,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,qBAAqB,GAChC,MAAM,OAAO,EACb,eAAgC,qBAA0B,KACzD,MAeF,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,eAAe,GAC1B,MAAM,IAAI,GAAG,IAAI,EACjB,eAAgC,qBAA0B,KACzD,MAcF,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,cAAc,GACzB,MAAM,OAAO,EACb,eAAgC,qBAA0B,KACzD,MAcF,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,cAAc,GACzB,MAAM,IAAI,GAAG,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,SAAS,EAC/C,yBAAkD,qBAA0B,KAC3E,MA2BF,CAAC;AAEF;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,yBAAyB,GACpC,MAAM,OAAO,EACb,eAAgC,qBAA0B,KACzD,MA0BF,CAAC;AAEF;;;;;;;;;;GAUG;AACH,eAAO,MAAM,yBAAyB,GACpC,MAAM,OAAO,EACb,eAAgC,qBAA0B,KACzD,MAcF,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,eAAO,MAAM,aAAa,GACxB,MAAM,IAAI,EACV,6BAAgD,cAAmB,KAClE,MA4CF,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,aAAa,GAAI,MAAM,IAAI,KAAG,MAS1C,CAAC;AAEF;;;;;GAKG;AACH;;;;;GAKG;AACH,eAAO,MAAM,iBAAiB,GAAI,sBAAsB,MAAM,KAAG,QAQhE,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,mBAAmB,GAAI,sBAAsB,MAAM,KAAG,MAQlE,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,qBAAqB,GAAI,sBAAsB,MAAM,KAAG,MAIpE,CAAC;AAEF;;;;;;;GAOG;AACH;;;GAGG;AACH,eAAO,MAAM,cAAc,GAAI,MAAM,IAAI,GAAG,IAAI,GAAG,SAAS,KAAG,oBAAoB,GAAG,IAYrF,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,cAAc,GACzB,UAAU,OAAO,CAAC,oBAAoB,CAAC,GAAG,IAAI,GAAG,SAAS,KACzD,IAAI,GAAG,IAOT,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,aAAa,GAAI,UAAU,OAAO,CAAC,oBAAoB,CAAC,KAAG,MAAM,GAAG,IAChC,CAAC;AAElD,KAAK,uBAAuB,GAAG;IAC7B,CAAC,QAAQ,EAAE,IAAI,EAAE,WAAW,CAAC,EAAE,IAAI,GAAG,MAAM,GAAG,IAAI,CAAC;IACpD,CAAC,QAAQ,EAAE,IAAI,EAAE,WAAW,EAAE,KAAK,GAAG,IAAI,GAAG,IAAI,CAAC;CACnD,CAAC;AAEF;;;;GAIG;AAGH,eAAO,MAAM,eAAe,EAAE,uBAgB7B,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,+BAA+B,GAAI,sBAAsB,MAAM,KAAG,MAsB9E,CAAC"}

package/dist/helpers/datetimeHelpers/index.d.ts

@@ -2,33 +2,43 @@ export declare const datetimeHelpers: {
     isDate: (date: unknown) => date is Date;
     dateOnlyString: (date: unknown, { timeZone }?: {
         timeZone?: string;
+        omitYear?: boolean;
     }) => string;
     dateOnlyStringNumeric: (date: unknown, { timeZone }?: {
         timeZone?: string;
+        omitYear?: boolean;
     }) => string;
     dateOnlyISOString: (date: unknown, { timeZone }?: {
         timeZone?: string;
+        omitYear?: boolean;
     }) => string;
     monthDayStringNumeric: (date: unknown, { timeZone }?: {
         timeZone?: string;
+        omitYear?: boolean;
     }) => string;
     dayOfWeekString: (date: Date | null, { timeZone }?: {
         timeZone?: string;
+        omitYear?: boolean;
     }) => string;
     timeOnlyString: (date: unknown, { timeZone }?: {
         timeZone?: string;
+        omitYear?: boolean;
     }) => string;
-    dateTimeString: (date: Date | number | string | null | undefined, { timeZone }?: {
+    dateTimeString: (date: Date | number | string | null | undefined, { timeZone, omitYear }?: {
         timeZone?: string;
+        omitYear?: boolean;
     }) => string;
     dateTimeStringForSentence: (date: unknown, { timeZone }?: {
         timeZone?: string;
+        omitYear?: boolean;
     }) => string;
     dateOnlyStringForSentence: (date: unknown, { timeZone }?: {
         timeZone?: string;
+        omitYear?: boolean;
     }) => string;
-    timeAgoString: (date: Date, { nowAnchor }?: {
+    timeAgoString: (date: Date, { nowAnchor, includeTime }?: {
         nowAnchor?: Date;
+        includeTime?: boolean;
     }) => string;
     dateUTCOffset: (date: Date) => string;
     buildTimeDuration: (numberOfMilliseconds: number) => {

package/dist/helpers/datetimeHelpers/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/helpers/datetimeHelpers/index.ts"],"names":[],"mappings":"AAuBA,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAqB3B,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/helpers/datetimeHelpers/index.ts"],"names":[],"mappings":"AAuBA,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAqB3B,CAAC"}