Skip to content

⬅️ Back to Table of Contents

📄 watchAtMost

📊 Analysis Summary

Metric Count
🔧 Functions 1
📦 Imports 13
📐 Interfaces 2

📚 Table of Contents

🛠️ File Location:

📂 packages/shared/watchAtMost/index.ts

📦 Imports

Name Source
MaybeRefOrGetter vue
MultiWatchSources vue
ShallowRef vue
WatchCallback vue
WatchSource vue
WatchStopHandle vue
MapOldSources ../utils
MapSources ../utils
WatchWithFilterOptions ../watchWithFilter
nextTick vue
shallowRef vue
toValue vue
watchWithFilter ../watchWithFilter

Functions

watchAtMost(sources: WatchSource<T>, cb: WatchCallback<T, Immediate extends true…, options: WatchAtMostOptions<Immediate>): WatchAtMostReturn

Parameters:

  • sources WatchSource<T>
  • cb WatchCallback<T, Immediate extends true ? T | undefined : T>
  • options WatchAtMostOptions<Immediate>

Returns: WatchAtMostReturn

Code 
export function watchAtMost<T, Immediate extends Readonly<boolean> = false>(
  sources: WatchSource<T>,
  cb: WatchCallback<T, Immediate extends true ? T | undefined : T>,
  options: WatchAtMostOptions<Immediate>,
): WatchAtMostReturn

Interfaces

WatchAtMostOptions<Immediate>

Interface Code 
export interface WatchAtMostOptions<Immediate> extends WatchWithFilterOptions<Immediate> {
  count: MaybeRefOrGetter<number>
}

Properties

Name Type Optional Description
count MaybeRefOrGetter<number> ✗ not shown

WatchAtMostReturn

Interface Code 
export interface WatchAtMostReturn {
  stop: WatchStopHandle
  pause: () => void
  resume: () => void
  count: ShallowRef<number>
}

Properties

Name Type Optional Description
stop WatchStopHandle ✗ not shown
pause () => void ✗ not shown
resume () => void ✗ not shown
count ShallowRef<number> ✗ not shown

Generated by Syntax Scribe