javascript-time-ago 2.3.8 → 2.3.9

package/README.md

@@ -37,7 +37,7 @@ If you're not using a bundler then use a [standalone version from a CDN](#cdn).
 import TimeAgo from 'javascript-time-ago'
 
 // English.
-import en from 'javascript-time-ago/locale/en'
+import en from 'javascript-time-ago/locale/en.json'
 
 TimeAgo.addDefaultLocale(en)
 
@@ -68,9 +68,9 @@ The `locale` argument of `new TimeAgo(locale)` constructor is matched against th
 The "default language" is `"en"` by default, and can be set either by calling `addDefaultLocale()`:
 
 ```js
-import ru from 'javascript-time-ago/locale/ru'
-import de from 'javascript-time-ago/locale/de'
-import es from 'javascript-time-ago/locale/es'
+import ru from 'javascript-time-ago/locale/ru.json'
+import de from 'javascript-time-ago/locale/de.json'
+import es from 'javascript-time-ago/locale/es.json'
 
 TimeAgo.addLocale(ru)
 TimeAgo.addLocale(de)
@@ -80,9 +80,9 @@ TimeAgo.addDefaultLocale(es)
 or by calling `setDefaultLocale()`:
 
 ```js
-import ru from 'javascript-time-ago/locale/ru'
-import de from 'javascript-time-ago/locale/de'
-import es from 'javascript-time-ago/locale/es'
+import ru from 'javascript-time-ago/locale/ru.json'
+import de from 'javascript-time-ago/locale/de.json'
+import es from 'javascript-time-ago/locale/es.json'
 
 TimeAgo.addLocale(ru)
 TimeAgo.addLocale(de)
@@ -115,7 +115,7 @@ An example of using Russian language:
 import TimeAgo from 'javascript-time-ago'
 
 // Russian.
-import ru from 'javascript-time-ago/locale/ru'
+import ru from 'javascript-time-ago/locale/ru.json'
 
 TimeAgo.addDefaultLocale(ru)
 
@@ -431,7 +431,7 @@ New labels can be added by calling `TimeAgo.addLabels()` function.
 
 ```js
 import TimeAgo from 'javascript-time-ago'
-import en from 'javascript-time-ago/locale/en'
+import en from 'javascript-time-ago/locale/en.json'
 import { round } from 'javascript-time-ago/locale/steps'
 
 TimeAgo.addDefaultLocale(en)
@@ -536,7 +536,7 @@ minTime(
 
 ##### `formatAs`
 
-A time measurement unit, the labels for which are used to generate the output of a step. If the time unit isn't supported by the language, then the step is ignored. The time units supported in all languages are: `second`, `minute`, `hour`, `day`, `week`, `quarter`, `month`, `year`. For [some languages](https://github.com/catamphetamine/javascript-time-ago/tree/master/locale-more-styles), this library also defines `now` unit (`"just now"`).
+A time measurement unit, the labels for which are used to generate the output of a step. If the time unit isn't supported by the language, then the step is ignored. The time units supported in all languages are: `second`, `minute`, `hour`, `day`, `week`, `month`, `quarter`, `year`. For [some languages](https://github.com/catamphetamine/javascript-time-ago/tree/master/locale-more-styles), this library also defines `now` unit (`"just now"`).
 
 ##### `format()`
 
@@ -701,11 +701,13 @@ When a `step` has `formatAs` configured, then `getTimeToNextUpdate()` function i
 getTimeToNextUpdate(
   date: number, // The date argument, converted to a timestamp.
   {
-    getTimeToNextUpdateForUnit(unit: string): number,
+    getTimeToNextUpdateForUnit(unit: string): number?,
                        // Returns "time to next update" for a time unit.
                        // This is what the library calls internally
                        // when `formatAs` is configured for a `step`.
-                       // Example: `getTimeToNextUpdateForUnit('minute')`
+                       // Example: `getTimeToNextUpdateForUnit('minute')`.
+                       // Can return `undefined` in edge cases:
+                       // for example, when `unit` is "now".
 
     now: number,       // The current date timestamp.
 
@@ -862,6 +864,10 @@ async function initIntl() {
 initIntl().then(...)
 ```
 
+## TypeScript
+
+This library comes with TypeScript "typings". If you happen to find any bugs in those, create an issue.
+
 <!--
 ## Contributing
 

package/bin/generate-locale-messages.js

@@ -52,7 +52,11 @@ for (const locale of getAllLocales()) {
 	const localeDirectory = path.join(localesDirectory, locale)
 	fs.outputFileSync(
 		path.join(localeDirectory, 'index.js'),
-		`module.exports = require('../${locale}.json')`
+		`
+var localeData = require('../${locale}.json')
+exports = module.exports = localeData
+exports['default'] = localeData
+		`.trim()
 	)
 }
 

package/index.d.ts

@@ -0,0 +1,129 @@
+export type DateInput = Date | number;
+
+export type Locale = string;
+
+export type LabelStyleName = 'long' | 'short' | 'narrow' | 'mini' | 'now';
+
+export type Rounding = 'round' | 'floor';
+
+// https://github.com/eemeli/make-plural/blob/master/packages/compiler/src/compile-range.js#L1
+export type Count = 'zero' | 'one' | 'two' | 'few' | 'many' | 'other';
+
+export type CommonUnit = 'year' | 'month' | 'week' | 'day' | 'hour' | 'minute' | 'second';
+export type Unit = CommonUnit | 'quarter' | 'now';
+
+export type CountLabels = {
+	[count in Count]?: string;
+}
+
+export interface PastAndFutureLabels {
+	past: string | CountLabels;
+	future: string | CountLabels;
+	previous?: string;
+	current?: string;
+	next?: string;
+}
+
+export interface PastAndFutureNowLabels {
+	past: string;
+	future: string;
+	current: string;
+}
+
+export type UnitLabels = string | CountLabels | PastAndFutureLabels
+
+export type Labels = {
+	year: UnitLabels;
+	quarter?: UnitLabels;
+	month: UnitLabels;
+	week: UnitLabels;
+	day: UnitLabels;
+	hour: UnitLabels;
+	minute: UnitLabels;
+	second: UnitLabels;
+}
+
+export type UnitLabelsMini = string | CountLabels;
+
+export type MiniLabels = {
+	year: UnitLabelsMini;
+	quarter?: UnitLabelsMini;
+	month: UnitLabelsMini;
+	week: UnitLabelsMini;
+	day: UnitLabelsMini;
+	hour: UnitLabelsMini;
+	minute: UnitLabelsMini;
+	second: UnitLabelsMini;
+}
+
+export type NowLabels = {
+	now: string | PastAndFutureNowLabels;
+}
+
+export type LocaleData = {
+	locale: Locale;
+	short: Labels;
+	narrow: Labels;
+	long: Labels;
+	mini?: MiniLabels;
+	now?: NowLabels;
+}
+
+export type FormatStyleName =
+	'round' |
+	'round-minute' |
+	'mini' |
+	'mini-now' |
+	'mini-minute' |
+	'mini-minute-now' |
+	'twitter' |
+	'twitter-now' |
+	'twitter-minute' |
+	'twitter-minute-now' |
+	'twitter-first-minute';
+
+export type MinTimeFunction = (date: number, options: {
+	future: boolean,
+	getMinTimeForUnit: (unit: Unit, prevUnit?: Unit) => number | void
+}) => number;
+
+export interface Step {
+	formatAs?: Unit;
+
+	minTime?: number | MinTimeFunction;
+
+	format?(date: DateInput, locale: Locale, options: {
+		formatAs: (unit: Unit, value: number) => string,
+		now: number,
+		future: boolean
+	}): string | void;
+
+	getTimeToNextUpdate?(date: DateInput, options: {
+		getTimeToNextUpdateForUnit: (unit: Unit) => number | void,
+		now: number,
+		future: boolean
+	}): number | void;
+}
+
+export interface Style {
+	steps: Step[];
+	labels: LabelStyleName | LabelStyleName[];
+}
+
+interface FormatOptions {
+	now?: number;
+	future?: boolean;
+	getTimeToNextUpdate?: boolean;
+	round?: Rounding;
+}
+
+export default class TimeAgo {
+  constructor(locale: Locale | Locale[], options?: { polyfill?: boolean });
+  format(date: DateInput, style?: FormatStyleName | Style, options?: FormatOptions): string | [string, number?];
+  format(date: DateInput, options: FormatOptions): string | [string, number?];
+  getLabels(labelsType: LabelStyleName | LabelStyleName[]): Labels;
+  static addLocale(localeData: LocaleData): void;
+  static addDefaultLocale(localeData: LocaleData): void;
+  static setDefaultLocale(locale: Locale): void;
+  static addLabels(locale: Locale, name: LabelStyleName, labels: Labels);
+}

package/locale/af/index.js

@@ -1 +1,3 @@
-module.exports = require('../af.json')
+var localeData = require('../af.json')
+exports = module.exports = localeData
+exports['default'] = localeData

package/locale/am/index.js

@@ -1 +1,3 @@
-module.exports = require('../am.json')
+var localeData = require('../am.json')
+exports = module.exports = localeData
+exports['default'] = localeData

package/locale/ar/index.js

@@ -1 +1,3 @@
-module.exports = require('../ar.json')
+var localeData = require('../ar.json')
+exports = module.exports = localeData
+exports['default'] = localeData

package/locale/ar-AE/index.js

@@ -1 +1,3 @@
-module.exports = require('../ar-AE.json')
+var localeData = require('../ar-AE.json')
+exports = module.exports = localeData
+exports['default'] = localeData

package/locale/as/index.js

@@ -1 +1,3 @@
-module.exports = require('../as.json')
+var localeData = require('../as.json')
+exports = module.exports = localeData
+exports['default'] = localeData

package/locale/ast/index.js

@@ -1 +1,3 @@
-module.exports = require('../ast.json')
+var localeData = require('../ast.json')
+exports = module.exports = localeData
+exports['default'] = localeData

package/locale/az/index.js

@@ -1 +1,3 @@
-module.exports = require('../az.json')
+var localeData = require('../az.json')
+exports = module.exports = localeData
+exports['default'] = localeData

package/locale/be/index.js

@@ -1 +1,3 @@
-module.exports = require('../be.json')
+var localeData = require('../be.json')
+exports = module.exports = localeData
+exports['default'] = localeData

package/locale/bg/index.js

@@ -1 +1,3 @@
-module.exports = require('../bg.json')
+var localeData = require('../bg.json')
+exports = module.exports = localeData
+exports['default'] = localeData

package/locale/bn/index.js

@@ -1 +1,3 @@
-module.exports = require('../bn.json')
+var localeData = require('../bn.json')
+exports = module.exports = localeData
+exports['default'] = localeData

package/locale/br/index.js

@@ -1 +1,3 @@
-module.exports = require('../br.json')
+var localeData = require('../br.json')
+exports = module.exports = localeData
+exports['default'] = localeData

package/locale/bs/index.js

@@ -1 +1,3 @@
-module.exports = require('../bs.json')
+var localeData = require('../bs.json')
+exports = module.exports = localeData
+exports['default'] = localeData

package/locale/bs-Cyrl/index.js

@@ -1 +1,3 @@
-module.exports = require('../bs-Cyrl.json')
+var localeData = require('../bs-Cyrl.json')
+exports = module.exports = localeData
+exports['default'] = localeData

package/locale/ca/index.js

@@ -1 +1,3 @@
-module.exports = require('../ca.json')
+var localeData = require('../ca.json')
+exports = module.exports = localeData
+exports['default'] = localeData

package/locale/ccp/index.js

@@ -1 +1,3 @@
-module.exports = require('../ccp.json')
+var localeData = require('../ccp.json')
+exports = module.exports = localeData
+exports['default'] = localeData

package/locale/ce/index.js

@@ -1 +1,3 @@
-module.exports = require('../ce.json')
+var localeData = require('../ce.json')
+exports = module.exports = localeData
+exports['default'] = localeData

package/locale/chr/index.js

@@ -1 +1,3 @@
-module.exports = require('../chr.json')
+var localeData = require('../chr.json')
+exports = module.exports = localeData
+exports['default'] = localeData

package/locale/cs/index.js

@@ -1 +1,3 @@
-module.exports = require('../cs.json')
+var localeData = require('../cs.json')
+exports = module.exports = localeData
+exports['default'] = localeData

package/locale/cy/index.js

@@ -1 +1,3 @@
-module.exports = require('../cy.json')
+var localeData = require('../cy.json')
+exports = module.exports = localeData
+exports['default'] = localeData

package/locale/da/index.js

@@ -1 +1,3 @@
-module.exports = require('../da.json')
+var localeData = require('../da.json')
+exports = module.exports = localeData
+exports['default'] = localeData

package/locale/de/index.js

@@ -1 +1,3 @@
-module.exports = require('../de.json')
+var localeData = require('../de.json')
+exports = module.exports = localeData
+exports['default'] = localeData

package/locale/dsb/index.js

@@ -1 +1,3 @@
-module.exports = require('../dsb.json')
+var localeData = require('../dsb.json')
+exports = module.exports = localeData
+exports['default'] = localeData

package/locale/dz/index.js

@@ -1 +1,3 @@
-module.exports = require('../dz.json')
+var localeData = require('../dz.json')
+exports = module.exports = localeData
+exports['default'] = localeData

package/locale/ee/index.js

@@ -1 +1,3 @@
-module.exports = require('../ee.json')
+var localeData = require('../ee.json')
+exports = module.exports = localeData
+exports['default'] = localeData

package/locale/el/index.js

@@ -1 +1,3 @@
-module.exports = require('../el.json')
+var localeData = require('../el.json')
+exports = module.exports = localeData
+exports['default'] = localeData

package/locale/en/index.js

@@ -1 +1,3 @@
-module.exports = require('../en.json')
+var localeData = require('../en.json')
+exports = module.exports = localeData
+exports['default'] = localeData

package/locale/en-001/index.js

@@ -1 +1,3 @@
-module.exports = require('../en-001.json')
+var localeData = require('../en-001.json')
+exports = module.exports = localeData
+exports['default'] = localeData

package/locale/en-150/index.js

@@ -1 +1,3 @@
-module.exports = require('../en-150.json')
+var localeData = require('../en-150.json')
+exports = module.exports = localeData
+exports['default'] = localeData

package/locale/en-AG/index.js

@@ -1 +1,3 @@
-module.exports = require('../en-AG.json')
+var localeData = require('../en-AG.json')
+exports = module.exports = localeData
+exports['default'] = localeData

package/locale/en-AI/index.js

@@ -1 +1,3 @@
-module.exports = require('../en-AI.json')
+var localeData = require('../en-AI.json')
+exports = module.exports = localeData
+exports['default'] = localeData

package/locale/en-AT/index.js

@@ -1 +1,3 @@
-module.exports = require('../en-AT.json')
+var localeData = require('../en-AT.json')
+exports = module.exports = localeData
+exports['default'] = localeData

package/locale/en-AU/index.js

@@ -1 +1,3 @@
-module.exports = require('../en-AU.json')
+var localeData = require('../en-AU.json')
+exports = module.exports = localeData
+exports['default'] = localeData

package/locale/en-BB/index.js

@@ -1 +1,3 @@
-module.exports = require('../en-BB.json')
+var localeData = require('../en-BB.json')
+exports = module.exports = localeData
+exports['default'] = localeData

package/locale/en-BE/index.js

@@ -1 +1,3 @@
-module.exports = require('../en-BE.json')
+var localeData = require('../en-BE.json')
+exports = module.exports = localeData
+exports['default'] = localeData

package/locale/en-BM/index.js

@@ -1 +1,3 @@
-module.exports = require('../en-BM.json')
+var localeData = require('../en-BM.json')
+exports = module.exports = localeData
+exports['default'] = localeData

package/locale/en-BS/index.js

@@ -1 +1,3 @@
-module.exports = require('../en-BS.json')
+var localeData = require('../en-BS.json')
+exports = module.exports = localeData
+exports['default'] = localeData

package/locale/en-BW/index.js

@@ -1 +1,3 @@
-module.exports = require('../en-BW.json')
+var localeData = require('../en-BW.json')
+exports = module.exports = localeData
+exports['default'] = localeData

package/locale/en-BZ/index.js

@@ -1 +1,3 @@
-module.exports = require('../en-BZ.json')
+var localeData = require('../en-BZ.json')
+exports = module.exports = localeData
+exports['default'] = localeData

package/locale/en-CA/index.js

@@ -1 +1,3 @@
-module.exports = require('../en-CA.json')
+var localeData = require('../en-CA.json')
+exports = module.exports = localeData
+exports['default'] = localeData

package/locale/en-CC/index.js

@@ -1 +1,3 @@
-module.exports = require('../en-CC.json')
+var localeData = require('../en-CC.json')
+exports = module.exports = localeData
+exports['default'] = localeData

package/locale/en-CH/index.js

@@ -1 +1,3 @@
-module.exports = require('../en-CH.json')
+var localeData = require('../en-CH.json')
+exports = module.exports = localeData
+exports['default'] = localeData

package/locale/en-CK/index.js

@@ -1 +1,3 @@
-module.exports = require('../en-CK.json')
+var localeData = require('../en-CK.json')
+exports = module.exports = localeData
+exports['default'] = localeData

package/locale/en-CM/index.js

@@ -1 +1,3 @@
-module.exports = require('../en-CM.json')
+var localeData = require('../en-CM.json')
+exports = module.exports = localeData
+exports['default'] = localeData

package/locale/en-CX/index.js

@@ -1 +1,3 @@
-module.exports = require('../en-CX.json')
+var localeData = require('../en-CX.json')
+exports = module.exports = localeData
+exports['default'] = localeData

package/locale/en-CY/index.js

@@ -1 +1,3 @@
-module.exports = require('../en-CY.json')
+var localeData = require('../en-CY.json')
+exports = module.exports = localeData
+exports['default'] = localeData

package/locale/en-DE/index.js

@@ -1 +1,3 @@
-module.exports = require('../en-DE.json')
+var localeData = require('../en-DE.json')
+exports = module.exports = localeData
+exports['default'] = localeData

package/locale/en-DG/index.js

@@ -1 +1,3 @@
-module.exports = require('../en-DG.json')
+var localeData = require('../en-DG.json')
+exports = module.exports = localeData
+exports['default'] = localeData

package/locale/en-DK/index.js

@@ -1 +1,3 @@
-module.exports = require('../en-DK.json')
+var localeData = require('../en-DK.json')
+exports = module.exports = localeData
+exports['default'] = localeData

package/locale/en-DM/index.js

@@ -1 +1,3 @@
-module.exports = require('../en-DM.json')
+var localeData = require('../en-DM.json')
+exports = module.exports = localeData
+exports['default'] = localeData

package/locale/en-ER/index.js

@@ -1 +1,3 @@
-module.exports = require('../en-ER.json')
+var localeData = require('../en-ER.json')
+exports = module.exports = localeData
+exports['default'] = localeData

package/locale/en-FI/index.js

@@ -1 +1,3 @@
-module.exports = require('../en-FI.json')
+var localeData = require('../en-FI.json')
+exports = module.exports = localeData
+exports['default'] = localeData

package/locale/en-FJ/index.js

@@ -1 +1,3 @@
-module.exports = require('../en-FJ.json')
+var localeData = require('../en-FJ.json')
+exports = module.exports = localeData
+exports['default'] = localeData

package/locale/en-FK/index.js

@@ -1 +1,3 @@
-module.exports = require('../en-FK.json')
+var localeData = require('../en-FK.json')
+exports = module.exports = localeData
+exports['default'] = localeData

package/locale/en-FM/index.js

@@ -1 +1,3 @@
-module.exports = require('../en-FM.json')
+var localeData = require('../en-FM.json')
+exports = module.exports = localeData
+exports['default'] = localeData

package/locale/en-GB/index.js

@@ -1 +1,3 @@
-module.exports = require('../en-GB.json')
+var localeData = require('../en-GB.json')
+exports = module.exports = localeData
+exports['default'] = localeData

package/locale/en-GD/index.js

@@ -1 +1,3 @@
-module.exports = require('../en-GD.json')
+var localeData = require('../en-GD.json')
+exports = module.exports = localeData
+exports['default'] = localeData

package/locale/en-GG/index.js

@@ -1 +1,3 @@
-module.exports = require('../en-GG.json')
+var localeData = require('../en-GG.json')
+exports = module.exports = localeData
+exports['default'] = localeData

package/locale/en-GH/index.js

@@ -1 +1,3 @@
-module.exports = require('../en-GH.json')
+var localeData = require('../en-GH.json')
+exports = module.exports = localeData
+exports['default'] = localeData

package/locale/en-GI/index.js

@@ -1 +1,3 @@
-module.exports = require('../en-GI.json')
+var localeData = require('../en-GI.json')
+exports = module.exports = localeData
+exports['default'] = localeData

package/locale/en-GM/index.js

@@ -1 +1,3 @@
-module.exports = require('../en-GM.json')
+var localeData = require('../en-GM.json')
+exports = module.exports = localeData
+exports['default'] = localeData

package/locale/en-GY/index.js

@@ -1 +1,3 @@
-module.exports = require('../en-GY.json')
+var localeData = require('../en-GY.json')
+exports = module.exports = localeData
+exports['default'] = localeData

package/locale/en-HK/index.js

@@ -1 +1,3 @@
-module.exports = require('../en-HK.json')
+var localeData = require('../en-HK.json')
+exports = module.exports = localeData
+exports['default'] = localeData

package/locale/en-IE/index.js

@@ -1 +1,3 @@
-module.exports = require('../en-IE.json')
+var localeData = require('../en-IE.json')
+exports = module.exports = localeData
+exports['default'] = localeData

package/locale/en-IL/index.js

@@ -1 +1,3 @@
-module.exports = require('../en-IL.json')
+var localeData = require('../en-IL.json')
+exports = module.exports = localeData
+exports['default'] = localeData