Newer
Older
CrypticOreWallet / typings / react-timeago / lib / formatters / index.d.ts
@Drew Lemmy Drew Lemmy on 14 Mar 2021 1 KB i18n: add timeago locales
// Copyright (c) 2020-2021 Drew Lemmy
// This file is part of KristWeb 2 under GPL-3.0.
// Full details: https://github.com/tmpim/KristWeb2/blob/master/LICENSE.txt

// TODO: PR this to DefinitelyTyped

// Based off of the Flow types:
// https://github.com/nmn/react-timeago/blob/master/src/formatters/buildFormatter.js

type Unit =
  | "second"
  | "minute"
  | "hour"
  | "day"
  | "week"
  | "month"
  | "year";

type Suffix = "ago" | "from now";

type Formatter = (
  value: number,
  unit: Unit,
  suffix: Suffix,
  epochMiliseconds: number,
  nextFormatter?: Formatter
) => React.ReactNode;

type StringOrFn = string | ((value: number, millisDelta: number) => string);
type NumberArray = [
  string,
  string,
  string,
  string,
  string,
  string,
  string,
  string,
  string,
  string,
];

interface L10nsStrings {
  prefixAgo?: StringOrFn;
  prefixFromNow?: StringOrFn;
  suffixAgo?: StringOrFn;
  suffixFromNow?: StringOrFn;
  second?: StringOrFn;
  seconds?: StringOrFn;
  minute?: StringOrFn;
  minutes?: StringOrFn;
  hour?: StringOrFn;
  hours?: StringOrFn;
  day?: StringOrFn;
  days?: StringOrFn;
  week?: StringOrFn;
  weeks?: StringOrFn;
  month?: StringOrFn;
  months?: StringOrFn;
  year?: StringOrFn;
  years?: StringOrFn;
  wordSeparator?: string;
  numbers?: NumberArray;
}

declare module "react-timeago/lib/formatters/*" {
  export default function buildFormatter(strings: L10nsStrings): Formatter;
}