Skip to content

⬅️ Back to Table of Contents

📄 index.ts

📊 Analysis Summary

Metric Count
🔧 Functions 1
📦 Imports 12
📐 Interfaces 2

📚 Table of Contents

🛠️ File Location:

📂 packages/shared/watchAtMost/index.ts

📦 Imports

Name Source
MaybeRefOrGetter 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: [...T], cb: WatchCallback<MapSources<T>, MapOldSources<T, Immediate>>, options: WatchAtMostOptions<Immediate>): WatchAtMostReturn

Code
export function watchAtMost<T extends Readonly<WatchSource<unknown>[]>, Immediate extends Readonly<boolean> = false>(sources: [...T], cb: WatchCallback<MapSources<T>, MapOldSources<T, Immediate>>, options: WatchAtMostOptions<Immediate>): WatchAtMostReturn
  • Parameters:
  • sources: [...T]
  • cb: WatchCallback<MapSources<T>, MapOldSources<T, Immediate>>
  • options: WatchAtMostOptions<Immediate>
  • Return Type: WatchAtMostReturn

Interfaces

WatchAtMostOptions<Immediate>

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

Properties

Name Type Optional Description
count MaybeRefOrGetter<number>

WatchAtMostReturn

Interface Code
export interface WatchAtMostReturn {
  stop: WatchStopHandle
  count: ShallowRef<number>
}

Properties

Name Type Optional Description
stop WatchStopHandle
count ShallowRef<number>