useNow

Category

Animation

Export Size

549 B

Last Changed

5 days ago

Reactive current Date instance.

Demo

Usage

import { useNow } from '@reause/core'

const now = useNow()

const { now, pause, resume } = useNow({ controls: true })

Type Declarations

export interface UseNowOptions<Controls extends boolean> {
    controls?: Controls;
    scheduler?: (cb: () => void) => Pausable;
}

export type UseNowReturn<Controls extends boolean> = Controls extends true ? ({
    now: Date;
} & Pausable) : Date

export interface Pausable {
    isActive: boolean;
    pause: () => void;
    resume: () => void;
}

export function useNow(options?: UseNowOptions<false>): Date

export function useNow(options: UseNowOptions<true>): {
    now: Date;
} & Pausable

export function useTimeoutPoll(fn: () => Awaitable<void>, interval: number, options?: UseTimeoutPollOptions): Pausable

Source

Source · Demo

Contributors

Changelog

v0.1.0 on

55039 - fix(core): resolve useNow audit findings (#610)