feat(useTimestamp): support interval option

vueuse · Mar 5, 2021 · bc09bba · bc09bba
1 parent 45fbe5a
commit bc09bba
Showing 1 changed file with 17 additions and 6 deletions.
diff --git a/packages/core/useTimestamp/index.ts b/packages/core/useTimestamp/index.ts
@@ -1,4 +1,4 @@
-import { timestamp } from '@vueuse/shared'
+import { Pausable, timestamp, useIntervalFn } from '@vueuse/shared'
 import { ref } from 'vue-demi'
 import { useRafFn } from '../useRafFn'
 
@@ -9,6 +9,13 @@ export interface TimestampOptions {
    * @default 0
    */
   offset?: number
+
+  /**
+   * Update interval, or use requestAnimationFrame
+   *
+   * @default requestAnimationFrame
+   */
+  interval?: 'requestAnimationFrame' | number
 }
 
 /**
@@ -18,14 +25,18 @@ export interface TimestampOptions {
  * @param options
  */
 export function useTimestamp(options: TimestampOptions = {}) {
-  const { offset = 0 } = options
+  const {
+    offset = 0,
+    interval = 'requestAnimationFrame',
+  } = options
 
   const ts = ref(timestamp() + offset)
 
-  const controls = useRafFn(
-    () => ts.value = timestamp() + offset,
-    { immediate: true },
-  )
+  const update = () => ts.value = timestamp() + offset
+
+  const controls: Pausable = interval === 'requestAnimationFrame'
+    ? useRafFn(update, { immediate: true })
+    : useIntervalFn(update, interval, true)
 
   return {
     timestamp: ts,