DefinitelyTyped/types/react-timeago/index.d.ts
2018-10-02 11:16:08 -07:00

36 lines
1.1 KiB
TypeScript

// Type definitions for react-timeago 4.1
// Project: https://github.com/nmn/react-timeago
// Definitions by: Konstantin Lebedev <https://github.com/koss-lebedev>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
// TypeScript Version: 2.8
import * as React from "react";
declare namespace ReactTimeago {
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;
interface ReactTimeagoProps {
readonly live?: boolean;
readonly minPeriod?: number;
readonly maxPeriod?: number;
readonly component?: string | React.ComponentType<any>;
readonly title?: string;
readonly formatter?: Formatter;
readonly date: string | number | Date;
readonly now?: () => number;
}
}
declare const ReactTimeago: React.ComponentClass<ReactTimeago.ReactTimeagoProps>;
export = ReactTimeago;