Class Watcher

对象属性变化监视器。

能用getset时就不使用watch，及时为了代码美观也尽量在低频使用的地方使用。

Hierarchy

Watcher

Index

Constructors

constructor

new Watcher(): Watcher
Returns Watcher

Properties

`Private` _binds

_binds: [any, string, (() => void), any, string, (() => void)][] = []

Methods

bind

bind<T0, T1, K0, K1>(object0, property0, object1, property1): void
绑定两个对象的指定属性，保存两个属性值同步。
Type Parameters
- T0
- T1
- K0 extends string | number | symbol
- K1 extends string | number | symbol
Parameters
- object0: T0
  
  第一个对象。
- property0: K0
  
  第一个对象的属性名称。
- object1: T1
  
  第二个对象。
- property1: K1
  
  第二个对象的属性名称。
Returns void
- Defined in watcher.ts:275

on

on(): WatchSession
创建一个 WatchSession 对象，用于监听对象属性的变化。 WatchSession 提供了多种监听方法，并且可以通过 off 方法一次性取消所有监听。

Returns WatchSession
返回一个包含监听方法和取消监听方法的 WatchSession 对象。
- Defined in watcher.ts:43

unbind

unbind<T0, T1, K0, K1>(object0, property0, object1, property1): void
解除两个对象的指定属性的绑定。
Type Parameters
- T0
- T1
- K0 extends string | number | symbol
- K1 extends string | number | symbol
Parameters
- object0: T0
  
  第一个对象。
- property0: K0
  
  第一个对象的属性名称。
- object1: T1
  
  第二个对象。
- property1: K1
  
  第二个对象的属性名称。
Returns void
- Defined in watcher.ts:300

unwatch

unwatch<T, K, V>(object, property, handler?, thisObject?): void
取消监听对象属性的变化
Type Parameters
- T
- K extends string | number | symbol
- V
Parameters
- object: T
  
  被监听对象
- property: K
  
  被监听属性
- Optional handler: ((newValue, oldValue, object, property) => void)
  
  变化回调函数 (newValue: V, oldValue: V, object: T, property: string) => void
  - - (newValue, oldValue, object, property): void
    - Parameters
      
      newValue: V
      
      oldValue: V
      
      object: T
      
      property: string
      
      Returns void
- Optional thisObject: any
  
  变化回调函数 this值
Returns void
- Defined in watcher.ts:189

unwatchchain

unwatchchain(object, property, handler?, thisObject?): void
取消监听对象属性链值变化
Parameters
- object: any
  
  被监听对象
- property: string
  
  被监听属性例如："a.b"
- Optional handler: ((newValue, oldValue, object, property) => void)
  
  变化回调函数 (object: T, property: string, oldValue: V) => void
  - - (newValue, oldValue, object, property): void
    - Parameters
      
      newValue: any
      
      oldValue: any
      
      object: any
      
      property: string
      
      Returns void
- Optional thisObject: any
  
  变化回调函数 this值
Returns void
- Defined in watcher.ts:398

unwatchobject

unwatchobject<T>(object, property, handler?, thisObject?): void
取消监听对象属性链值变化
Type Parameters
- T
Parameters
- object: T
  
  被监听对象
- property: gPartial<T>
  
  被监听属性例如：{a:{b:null,d:null}} 表示监听 object.a.b 与 object.a.d 值得变化，如果property===object时表示监听对象中所有叶子属性变化。
- Optional handler: ((newValue, oldValue, host, property) => void)
  
  变化回调函数 newValue: any, oldValue: any, host: any, property: string => void
  - - (newValue, oldValue, host, property): void
    - Parameters
      
      newValue: any
      
      oldValue: any
      
      host: any
      
      property: string
      
      Returns void
- Optional thisObject: any
  
  变化回调函数 this值
Returns void
- Defined in watcher.ts:472

unwatchs

unwatchs<T, K, V>(object, propertys, handler, thisObject?): void
取消监听对象属性的变化
Type Parameters
- T
- K extends string | number | symbol
- V
Parameters
- object: T
  
  被监听对象
- propertys: K[]
- handler: ((newValue, oldValue, object, property) => void)
  
  变化回调函数 (newValue: V, oldValue: V, object: T, property: string) => void
  - - (newValue, oldValue, object, property): void
    - Parameters
      
      newValue: V
      
      oldValue: V
      
      object: T
      
      property: string
      
      Returns void
- Optional thisObject: any
  
  变化回调函数 this值
Returns void
- Defined in watcher.ts:257

watch

watch<T, K, V>(object, property, handler, thisObject?, onlyChanged?, topObject?, fullProperty?): void
监听对象属性的变化

注意：使用watch后获取该属性值的性能将会是原来的1/60，避免在运算密集处使用该函数。
Type Parameters
- T
- K extends string | number | symbol
- V
Parameters
- object: T
  
  被监听对象
- property: K
  
  被监听属性
- handler: ((newValue, oldValue, object, property) => void)
  
  变化回调函数 (newValue: V, oldValue: V, object: T, property: string) => void
  - - (newValue, oldValue, object, property): void
    - Parameters
      
      newValue: V
      
      oldValue: V
      
      object: T
      
      property: string
      
      Returns void
- Optional thisObject: any
  
  变化回调函数 this值
- onlyChanged: boolean = true
  
  值为 true 时表示只在变化时才触发回调函数，否则只要被赋值就触发回调函数。默认为 true 。
- Optional topObject: any
- Optional fullProperty: string
Returns void
- Defined in watcher.ts:106

watchchain

watchchain(object, property, handler, thisObject?, onlyChanged?, topObject?, fullProperty?): void
监听对象属性链值变化
Parameters
- object: any
  
  被监听对象
- property: string
  
  被监听属性例如："a.b"
- handler: ((newValue, oldValue, object, property) => void)
  
  变化回调函数 (newValue: any, oldValue: any, object: any, property: string) => void
  - - (newValue, oldValue, object, property): void
    - Parameters
      
      newValue: any
      
      oldValue: any
      
      object: any
      
      property: string
      
      Returns void
- Optional thisObject: any
  
  变化回调函数 this值
- onlyChanged: boolean = true
  
  值为 true 时表示只在变化时才触发回调函数，否则只要被赋值就触发回调函数。默认为 true 。
- Optional topObject: any
- Optional fullProperty: string
Returns void
- Defined in watcher.ts:330

watchobject

watchobject<T>(object, property, handler, thisObject?, onlyChanged?): void
监听对象属性链值变化
Type Parameters
- T
Parameters
- object: T
  
  被监听对象
- property: gPartial<T>
  
  被监听属性例如：{a:{b:null,d:null}} 表示监听 object.a.b 与 object.a.d 值得变化，如果property===object时表示监听对象中所有叶子属性变化。
- handler: ((newValue, oldValue, host, property) => void)
  
  变化回调函数 (newValue: any, oldValue: any, host: any, property: string) => void
  - - (newValue, oldValue, host, property): void
    - Parameters
      
      newValue: any
      
      oldValue: any
      
      host: any
      
      property: string
      
      Returns void
- Optional thisObject: any
  
  变化回调函数 this值
- onlyChanged: boolean = true
  
  值为 true 时表示只在变化时才触发回调函数，否则只要被赋值就触发回调函数。默认为 true 。
Returns void
- Defined in watcher.ts:454

watchs

watchs<T, K, V>(object, propertys, handler, thisObject?, onlyChanged?): void
监听对象属性的变化

注意：使用watch后获取该属性值的性能将会是原来的1/60，避免在运算密集处使用该函数。
Type Parameters
- T
- K extends string | number | symbol
- V
Parameters
- object: T
  
  被监听对象
- propertys: K[]
- handler: ((newValue, oldValue, object, property) => void)
  
  变化回调函数 (newValue: V, oldValue: V, object: T, property: string) => void
  - - (newValue, oldValue, object, property): void
    - Parameters
      
      newValue: V
      
      oldValue: V
      
      object: T
      
      property: string
      
      Returns void
- Optional thisObject: any
  
  变化回调函数 this值
- onlyChanged: boolean = true
  
  值为 true 时表示只在变化时才触发回调函数，否则只要被赋值就触发回调函数。默认为 true 。
Returns void
- Defined in watcher.ts:241

Class Watcher

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns Watcher

Properties

Private _binds

Methods

bind

Type Parameters

T0

T1

K0 extends string | number | symbol

K1 extends string | number | symbol

Parameters

object0: T0

property0: K0

object1: T1

property1: K1

Returns void

on

Returns WatchSession

unbind

Type Parameters

T0

T1

K0 extends string | number | symbol

K1 extends string | number | symbol

Parameters

object0: T0

property0: K0

object1: T1

property1: K1

Returns void

unwatch

Type Parameters

T

K extends string | number | symbol

V

Parameters

object: T

property: K

Optional handler: ((newValue, oldValue, object, property) => void)

Parameters

newValue: V

oldValue: V

object: T

property: string

Returns void

Optional thisObject: any

Returns void

unwatchchain

Parameters

object: any

property: string

Optional handler: ((newValue, oldValue, object, property) => void)

Parameters

newValue: any

oldValue: any

object: any

property: string

Returns void

Optional thisObject: any

Returns void

unwatchobject

Type Parameters

T

Parameters

object: T

property: gPartial<T>

Optional handler: ((newValue, oldValue, host, property) => void)

Parameters

newValue: any

oldValue: any

host: any

property: string

`Private` _binds

`Optional` handler: ((newValue, oldValue, object, property) => void)

`Optional` thisObject: any

`Optional` handler: ((newValue, oldValue, object, property) => void)

`Optional` thisObject: any

`Optional` handler: ((newValue, oldValue, host, property) => void)

`Optional` thisObject: any

`Optional` thisObject: any

`Optional` thisObject: any

`Optional` topObject: any

`Optional` fullProperty: string

`Optional` thisObject: any

`Optional` topObject: any

`Optional` fullProperty: string

`Optional` thisObject: any