数据操作

get(keypath): *

获取数据。

set(keypath, value)

设置数据。

当 keypath 是 object 时，可批量设置。

事件处理

on(type, listener): Yox

监听事件。

当 type 是 object 时，可批量监听。

off(type, listener): Yox

取消监听事件。

当 type 是 object 时，可批量取消监听。

once(type, listener): Yox

监听一次事件就取消。

当 type 是 object 时，可批量一次监听。

fire(type, ?data, ?downward): boolean

触发事件。

事件可以选择向上或向下，默认向上冒泡到根组件，如果 downward 参数传入 true，会向下发事件给它的子组件。

该方法返回一个布尔值，表示事件流是否正常结束（即没有被中断）。

数据监听

watch(keypath, watcher, ?sync): Yox

监听数据变化。

当 keypath 是 object 时，可批量监听。

当 sync 是 true 时，会立即执行一次 watcher。

unwatch(keypath, watcher): Yox

取消监听事件。

当 keypath 是 object 时，可批量取消监听。

watchOnce(keypath, watcher, ?sync): Yox

监听一次数据变化就取消。

当 keypath 是 object 时，可批量一次监听。

当 sync 是 true 时，会立即执行一次 watcher。

生命周期

updateView(oldNode, newNode)

更新视图。

设值会自动触发视图更新，除非必要，不应手动调用 updateView()。

destroy()

销毁组件。

工具方法

nextTick(fn)

注册下一个时间片执行的函数。

不理解此概念请参考 Vue 文档。

toggle(keypath): boolean

取反 keypath 对应的数据。

返回取反后的值。

increase(keypath, ?step, ?max): number

递增 keypath 对应的数字。

返回递增后的值。

默认递增 1，可配置增量，也可配置递增的最大值。

decrease(keypath, ?step, ?min): number

递减 keypath 对应的数字。

返回递减后的值。

默认递减 1，可配置减量，也可配置递减的最小值。

copy(target, ?deep)

克隆对象，支持深度克隆。

修改引用对象时，此方法比较常用。

数组方法

append(keypath, item): boolean

在数组尾部添加元素，返回是否添加成功。

prepend(keypath, item): boolean

在数组头部添加元素，返回是否添加成功。

insert(keypath, item, index): boolean

指定元素的插入位置，返回是否插入成功。

remove(keypath, item): boolean

从数组中删除一个元素，返回是否删除成功。

removeAt(keypath, index): boolean

通过索引删除数组中的元素，返回是否删除成功。

静态方法

nextTick(fn)

注册下一个时间片执行的函数。

不理解此概念请参考 Vue 文档。

use(plugin)

安装插件。

checkPropTypes(props, propTypes): Object

外部数据校验，不爽可重写。