reactiveUtils

方法概览

方法详情

on(getTarget, eventName, callback, options){WatchHandle}static

监视 getTarget 函数返回的值是否有更改，并根据需要自动添加或删除给定事件的事件侦听器。

参数:

getTarget OnExpression 返回要添加事件侦听器的对象的函数。

eventName String 要为其添加侦听器的事件的名称。

callback OnCallback 事件处理回调函数。

options ListenerOptions optional 用于配置跟踪如何发生以及如何调用回调的选项。

返回:

类型	说明
WatchHandle	监视处理。

once(getValue, signal){Promise}static

跟踪获取值时访问的任何属性，并返回一个承诺，该承诺在 getValue() 更改时返回的值解析。

参数:

getValue WatchExpression 要跟踪的表达式。

signal AbortSignal optional Abort 信号，可用于取消 Promise 的解析。

返回:

类型	说明
Promise	当跟踪的表达式更改时解决的承诺。

watch(getValue, callback, options){WatchHandle}static

跟踪获取值时访问的任何属性，并在其中任何一个更改时调用回调。

参数:

getValue WatchExpression 用于获取当前值的函数。将跟踪所有访问的属性。

callback WatchCallback 有变化时调用的函数。

options WatchOptions optional 用于配置跟踪如何发生以及如何调用回调的选项。

返回:

类型	说明
WatchHandle	监视处理。

when(getValue, callback, options){WatchHandle}static

监视 getValue 函数返回的值，并在它变为真时调用回调。

参数:

getValue WatchExpression 用于获取当前值的函数。将跟踪所有访问的属性。

callback WatchCallback 当值变为真时调用的函数。

options WatchOptions optional 用于配置跟踪如何发生以及如何调用回调的选项。

返回:

类型	说明
WatchHandle	监视处理。

whenOnce(getValue, signal){Promise}static

跟踪获取值时访问的任何属性，并返回一个 Promise，当它变为真时，该 Promise 将使用 getValue() 返回的值解析。

参数:

getValue WatchExpression 要跟踪的表达式。

signal AbortSignal optional Abort 信号，可用于取消 Promise 的解析。

返回:

类型	说明
Promise	一个承诺，一旦跟踪的表达式变为真，就会解决。

类型定义

EqualityFunction(newValue, oldValue){Boolean}

用于检查两个值是否相同的函数，在这种情况下不调用 watch 回调。

参数:

newValue * 新值。

oldValue * 旧值。

返回:

类型	说明
Boolean	新值是否等于旧值。

ListenerChangeCallback(target)

添加或删除事件侦听器时要调用的回调。

参数:

target * optional 添加或删除侦听器的事件目标。

ListenerOptions Object

用于配置 reactiveUtils 行为的选项。

属性:

sync Boolean optional 是同步触发回调还是在下一个滴答时触发。

once Boolean optional 是否只触发一次回调。

OnCallback(event)

发出或分派事件时调用的函数。

参数:

event *

目标发出的事件。

OnExpression(){*}

自动跟踪的函数，应返回要添加事件侦听器的事件目标。

返回:

类型	说明
*	事件目标。

WatchCallback(newValue, oldValue)

值更改时要调用的函数。

参数:

newValue * 新值。

oldValue * 旧值。

WatchExpression(){*}

自动跟踪的函数，应返回一个值以传递给 WatchCallback

返回:

类型	说明
*	新值。

WatchOptions Object

用于配置如何执行自动跟踪以及如何调用回调的选项。

属性:

initial Boolean optional 如果满足必要条件，是否在初始化后立即触发回调。

sync Boolean optional 是同步触发回调还是在下一个滴答时触发。

once Boolean optional 是否只触发一次回调。

equals EqualityFunction optional 用于检查两个值是否相同的函数，在这种情况下不调用回调。