windups/dist/react/useWindup.d.ts

A unique typewriter effect library for React.

import { Windup } from "../Windup";
export interface HookMetadata {
    onChar?: (char: string) => void;
    pace?: (char: string, nextChar: string | undefined) => number;
}
export default function useWindup<M extends HookMetadata>(windupInit: Windup<string, M>, options: {
    onFinished?: () => void;
    skipped?: boolean;
}): {
    windup: Windup<string, M>;
    skip: () => void;
    pause: () => void;
    resume: () => void;
    rewind: () => void;
    isFinished: boolean;
};