@daysnap/horn-use
Version:
horn use
21 lines (20 loc) • 497 B
TypeScript
type Fn = () => void;
export interface UseRafFnOptions {
/**
* Start the requestAnimationFrame loop immediately on creation
*
* @default true
*/
immediate?: boolean;
}
/**
* Call function on every `requestAnimationFrame`. With controls of pausing and resuming.
* @param fn
* @param options
*/
export declare function useRaf(fn: Fn, options?: UseRafFnOptions): {
isActive: import("vue").Ref<boolean>;
pause: () => void;
resume: () => void;
};
export {};