Skip to content
On this page

useTimestamp

Category
Last Changed
6 months ago

Reactive current timestamp

Demo

Timestamp: 1656271588489

Usage

import { useTimestamp } from '@vueuse/core'

const timestamp = useTimestamp({ offset: 0 })
import { useTimestamp } from '@vueuse/core'

const timestamp = useTimestamp({ offset: 0 })
const { timestamp, pause, resume } = useTimestamp({ controls: true })
const { timestamp, pause, resume } = useTimestamp({ controls: true })

Component Usage

This function also provides a renderless component version via the @vueuse/components package. Learn more about the usage.

<UseTimestamp v-slot="{ timestamp, pause, resume }">
  Current Time: {{ timestamp }}
  <button @click="pause()">Pause</button>
  <button @click="resume()">Resume</button>
</UseTimestamp>
<UseTimestamp v-slot="{ timestamp, pause, resume }">
  Current Time: {{ timestamp }}
  <button @click="pause()">Pause</button>
  <button @click="resume()">Resume</button>
</UseTimestamp>

Type Declarations

export interface TimestampOptions<Controls extends boolean> {
  /**
   * Expose more controls
   *
   * @default false
   */
  controls?: Controls
  /**
   * Offset value adding to the value
   *
   * @default 0
   */
  offset?: number
  /**
   * Update the timestamp immediately
   *
   * @default true
   */
  immediate?: boolean
  /**
   * Update interval, or use requestAnimationFrame
   *
   * @default requestAnimationFrame
   */
  interval?: "requestAnimationFrame" | number
}
/**
 * Reactive current timestamp.
 *
 * @see https://vueuse.org/useTimestamp
 * @param options
 */
export declare function useTimestamp(
  options?: TimestampOptions<false>
): Ref<number>
export declare function useTimestamp(options: TimestampOptions<true>): {
  timestamp: Ref<number>
} & Pausable
export declare type UseTimestampReturn = ReturnType<typeof useTimestamp>
export interface TimestampOptions<Controls extends boolean> {
  /**
   * Expose more controls
   *
   * @default false
   */
  controls?: Controls
  /**
   * Offset value adding to the value
   *
   * @default 0
   */
  offset?: number
  /**
   * Update the timestamp immediately
   *
   * @default true
   */
  immediate?: boolean
  /**
   * Update interval, or use requestAnimationFrame
   *
   * @default requestAnimationFrame
   */
  interval?: "requestAnimationFrame" | number
}
/**
 * Reactive current timestamp.
 *
 * @see https://vueuse.org/useTimestamp
 * @param options
 */
export declare function useTimestamp(
  options?: TimestampOptions<false>
): Ref<number>
export declare function useTimestamp(options: TimestampOptions<true>): {
  timestamp: Ref<number>
} & Pausable
export declare type UseTimestampReturn = ReturnType<typeof useTimestamp>

Source

SourceDemoDocs

Contributors

Anthony Fu
Scott Bedard
Shinigami
wheat
Alex Kozack
Antério Vieira

Changelog

No recent changes
useTimestamp has loaded