README.md

中文 | English

smart-observe

smart-observe 来自 Vue.js，是一个小巧、高效，用于监测 javascript 对象、数组、类 变化的库

安装

npm install --save smart-observe

或

bower install --save smart-observe

使用

监测属性 observe.watch(target, expression, callback) 或 observe(target, expression, callback)

试一试： codepen jsfiddle

const target = {a: 1}
observe(target, 'a', function (newValue, oldValue) {
  console.log(newValue, oldValue)
})
target.a = 3
// 3 1

添加计算属性 observe.compute(target, name, getter)

试一试： codepen jsfiddle

const target = {a: 1}
observe.compute(target, 'b', function () {
  return this.a * 2
})
console.log(target.b)
// 2
target.a = 3
console.log(target.b)
// 6

监测属性并添加计算属性 observe.react(options)

试一试： codepen jsfiddle

const options = {
  data: {
    PI: Math.PI,
    radius: 1,
  },
  computed: {
    'area': function () {
      return this.PI * this.square(this.radius) // πr²
    },
  },
  watchers: {
    'area': function (newValue, oldValue) {
      console.log(`area: ${newValue}`)
    },
  },
  methods: {
    square (num) {
      return num * num
    },
  },
}
const target = observe.react(options)
target.radius = 3
// area: 28.274333882308138

API

属性

名称	类型	值	说明
observe.deep	boolean	默认为 false	如果为 true，observe.watch(target, expression, callback) 将会对 target 深度监测
observe.sync	boolean	默认为 false	如果为 true，observe.watch(target, expression, callback) 监测到属性变化时，立即调用回调函数
observe.default	function	只能为 observe.react，observe.watch 或 observe.compute， 默认为 observe.watch	设置 observe(...) 实际调用的方法，写起来简洁一些

方法

observe(...)

• 为方法 observe.default 的语法糖，observe.default 参见属性

observe.watch(target, expression, callback)

• target: 任意对象
• expression: string 或 function
• callback: function
• 返回 Watcher，调用 watcher.teardown() 可以取消监测

observe.compute(target, name, accessor, cache)

• target: 任意对象
• name: string
• accessor:
  • function: 会作为 getter，等同传入 {get: accessor}
  • Object: 可以包含：(其中，至少包含 get 或 set)
    • get: function
    • set: function
    • cache: boolean，可选，默认为 true，如果设为 false，每次读取计算属性都要重新计算
• cache: boolean，可选，默认为 true，仅当 accessor 为 function 时有效。

observe.react(options, target)

• options: Object，要配置的参数集合，可以包含:
  • data: 要附加的字段
  • computed: 要附加的计算属性
  • watchers: 要监测的属性和计算属性
  • methods: 要附加的方法，这些方法将会自动绑定 target
• target: 任意对象，可选，默认为空对象，options 的参数将附加到此对象上
• 返回 target

License

MIT