⬅️ Back to Table of Contents

📄 useNow

📊 Analysis Summary

Metric	Count
🔧 Functions	2
📦 Imports	5
📐 Interfaces	1
📑 Type Aliases	1

📚 Table of Contents

• Imports
• Functions
• Interfaces
• Type Aliases

🛠️ File Location:

📂 packages/core/useNow/index.ts

📦 Imports

Name	Source
Pausable	@vueuse/shared
ShallowRef	vue
ConfigurableScheduler	../_configurable
shallowRef	vue
useRafFn	../useRafFn

---

Functions

useNow(options: UseNowOptions<false>): ShallowRef<Date>

Reactive current Date instance.

Parameters:

• options any: No description

See: https://vueuse.org/useNow

Tags: @__NO_SIDE_EFFECTS__

Raw JSDoc

/**
 * Reactive current Date instance.
 *
 * @see https://vueuse.org/useNow
 * @param options
 *
 * @__NO_SIDE_EFFECTS__
 */

Code

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

Internal helpers

Declared inside another function in this file.

update(): Date

Returns: Date

Code

() => now.value = new Date()

---

Interfaces

UseNowOptions<Controls extends boolean>

Interface Code

export interface UseNowOptions<Controls extends boolean> extends ConfigurableScheduler {
  /**
   * Expose more controls
   *
   * @default false
   */
  controls?: Controls
}

Properties

Name	Type	Optional	Description
controls	Controls	✓	not shown

---

Type Aliases

UseNowReturn<Controls extends boolean>

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

---

Generated by Syntax Scribe