chore: consolidate new foundation and archive v1 (#1495)

This commit is contained in:
2026-09-07 12:32:57 -05:00
3511 changed files with 727899 additions and 10 deletions
@@ -0,0 +1,79 @@
---
category: Animation
---
# useTimestamp
Reactive current timestamp
## Usage
```ts
import { useTimestamp } from '@vueuse/core';
const timestamp = useTimestamp({ offset: 0 });
```
```ts
import { useTimestamp } from '@vueuse/core';
// ---cut---
const { timestamp, pause, resume } = useTimestamp({ controls: true });
```
## Component Usage
```vue
<template>
<UseTimestamp v-slot="{ timestamp, pause, resume }">
Current Time: {{ timestamp }}
<button @click="pause()">Pause</button>
<button @click="resume()">Resume</button>
</UseTimestamp>
</template>
```
## Type Declarations
```ts
export interface UseTimestampOptions<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;
/**
* Callback on each update
*/
callback?: (timestamp: number) => void;
}
/**
* Reactive current timestamp.
*
* @see https://vueuse.org/useTimestamp
* @param options
*/
export declare function useTimestamp(options?: UseTimestampOptions<false>): ShallowRef<number>;
export declare function useTimestamp(options: UseTimestampOptions<true>): {
timestamp: ShallowRef<number>;
} & Pausable;
export type UseTimestampReturn = ReturnType<typeof useTimestamp>;
```