forked from vueuse/vueuse
-
Notifications
You must be signed in to change notification settings - Fork 0
/
filters.ts
170 lines (142 loc) · 3.87 KB
/
filters.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
import { ref, unref } from 'vue-demi'
import type { Fn, MaybeRef, Pausable } from './types'
export type FunctionArgs<Args extends any[] = any[], Return = void> = (...args: Args) => Return
export interface FunctionWrapperOptions<Args extends any[] = any[], This = any> {
fn: FunctionArgs<Args, This>
args: Args
thisArg: This
}
export type EventFilter<Args extends any[] = any[], This = any> = (
invoke: Fn,
options: FunctionWrapperOptions<Args, This>
) => void
export interface ConfigurableEventFilter {
/**
* Filter for if events should to be received.
*
* @see https://vueuse.org/guide/config.html#event-filters
*/
eventFilter?: EventFilter
}
export interface DebounceFilterOptions {
/**
* The maximum time allowed to be delayed before it's invoked.
* In milliseconds.
*/
maxWait?: number
}
/**
* @internal
*/
export function createFilterWrapper<T extends FunctionArgs>(filter: EventFilter, fn: T) {
function wrapper(this: any, ...args: any[]) {
filter(() => fn.apply(this, args), { fn, thisArg: this, args })
}
return wrapper as any as T
}
export const bypassFilter: EventFilter = (invoke) => {
return invoke()
}
/**
* Create an EventFilter that debounce the events
*
* @param ms
* @param [maxWait=null]
*/
export function debounceFilter(ms: MaybeRef<number>, options: DebounceFilterOptions = {}) {
let timer: ReturnType<typeof setTimeout> | undefined
let maxTimer: ReturnType<typeof setTimeout> | undefined | null
const filter: EventFilter = (invoke) => {
const duration = unref(ms)
const maxDuration = unref(options.maxWait)
if (timer)
clearTimeout(timer)
if (duration <= 0 || (maxDuration !== undefined && maxDuration <= 0)) {
if (maxTimer) {
clearTimeout(maxTimer)
maxTimer = null
}
return invoke()
}
// Create the maxTimer. Clears the regular timer on invokation
if (maxDuration && !maxTimer) {
maxTimer = setTimeout(() => {
if (timer)
clearTimeout(timer)
maxTimer = null
invoke()
}, maxDuration)
}
// Create the regular timer. Clears the max timer on invokation
timer = setTimeout(() => {
if (maxTimer)
clearTimeout(maxTimer)
maxTimer = null
invoke()
}, duration)
}
return filter
}
/**
* Create an EventFilter that throttle the events
*
* @param ms
* @param [trailing=true]
* @param [leading=true]
*/
export function throttleFilter(ms: MaybeRef<number>, trailing = true, leading = true) {
let lastExec = 0
let timer: ReturnType<typeof setTimeout> | undefined
let isLeading = true
const clear = () => {
if (timer) {
clearTimeout(timer)
timer = undefined
}
}
const filter: EventFilter = (invoke) => {
const duration = unref(ms)
const elapsed = Date.now() - lastExec
clear()
if (duration <= 0) {
lastExec = Date.now()
return invoke()
}
if (elapsed > duration && (leading || !isLeading)) {
lastExec = Date.now()
invoke()
}
else if (trailing) {
timer = setTimeout(() => {
lastExec = Date.now()
isLeading = true
clear()
invoke()
}, duration)
}
if (!leading && !timer)
timer = setTimeout(() => isLeading = true, duration)
isLeading = false
}
return filter
}
/**
* EventFilter that gives extra controls to pause and resume the filter
*
* @param extendFilter Extra filter to apply when the PausableFilter is active, default to none
*
*/
export function pausableFilter(extendFilter: EventFilter = bypassFilter): Pausable & { eventFilter: EventFilter } {
const isActive = ref(true)
function pause() {
isActive.value = false
}
function resume() {
isActive.value = true
}
const eventFilter: EventFilter = (...args) => {
if (isActive.value)
extendFilter(...args)
}
return { isActive, pause, resume, eventFilter }
}