react-timed-renderer/dist/components/TimedRenderer.d.ts

React component that re-renders at the interval provided.

/// <reference types="react" />
export interface TimedRendererProps {
    /** Time between renders in milliseconds. Defaults to 5000 (5 seconds). */
    interval?: number;
    /**
     * Renders the JSX element. Time parameter (in milliseconds since the epoch) for the start of each period is provided for convenience.
     *
     * @param time The time for the beginning of each period in milliseconds since the epoch.
     * @returns The JSX element to render, or undefined.
     */
    render?: (time: number) => JSX.Element;
}
/**
 * See documentation: [TimedRenderer](https://justinmahar.github.io/react-timed-renderer/?path=/story/docs-timedrenderer--docs)
 *
 * A TimedRenderer can be used to render a component at timed intervals.
 *
 * Just provide the interval in milliseconds and a render prop, and the component will reliably render at the interval provided.
 */
export declare function TimedRenderer({ interval, render }: TimedRendererProps): JSX.Element;