Skip to content

⬅️ Back to Table of Contents

📄 watchPausable

📊 Analysis Summary

Metric Count
🔧 Functions 1
📦 Imports 11
📊 Variables & Constants 1
📐 Interfaces 1
📑 Type Aliases 1

📚 Table of Contents

🛠️ File Location:

📂 packages/shared/watchPausable/index.ts

📦 Imports

Name Source
MultiWatchSources vue
WatchCallback vue
WatchSource vue
WatchStopHandle vue
MapOldSources ../utils
MapSources ../utils
Pausable ../utils
PausableFilterOptions ../utils
WatchWithFilterOptions ../watchWithFilter
pausableFilter ../utils
watchWithFilter ../watchWithFilter

Variables & Constants

Name Type Kind Value Exported
pausableWatch { <T, Immediate extends Readonly<bool... const watchPausable ✓

Functions

watchPausable(source: WatchSource<T>, cb: WatchCallback<T, Immediate extends true…, options: WatchPausableOptions<Immediate>): WatchPausableReturn

⚠️ DEPRECATED: Use Vue's built-in watch instead. This function will be removed in future version.

Raw JSDoc 
/** @deprecated Use Vue's built-in `watch` instead. This function will be removed in future version. */
Code 
export function watchPausable<T, Immediate extends Readonly<boolean> = false>(source: WatchSource<T>, cb: WatchCallback<T, Immediate extends true ? T | undefined : T>, options?: WatchPausableOptions<Immediate>): WatchPausableReturn

Interfaces

WatchPausableReturn

Interface Code 
export interface WatchPausableReturn extends Pausable {
  stop: WatchStopHandle
}

Properties

Name Type Optional Description
stop WatchStopHandle ✗ not shown

Type Aliases

WatchPausableOptions<Immediate>

type WatchPausableOptions<Immediate> = WatchWithFilterOptions<Immediate> & PausableFilterOptions;

Generated by Syntax Scribe