Interface WatchSession

WatchSession 提供了多种监听方法，并且可以通过 off 方法一次性取消所有监听

Hierarchy

WatchSession

Index

Methods

bind off watch watchchain watchobject watchs

Methods

bind

bind<T0, T1, K0, K1>(object0, property0, object1, property1): WatchSession
绑定两个对象的属性，使它们的值保持同步。
Type Parameters
- T0
- T1
- K0 extends string | number | symbol
- K1 extends string | number | symbol
Parameters
- object0: T0
  
  第一个对象。
- property0: K0
  
  第一个对象的属性名。
- object1: T1
  
  第二个对象。
- property1: K1
  
  第二个对象的属性名。
Returns WatchSession
返回当前的 WatchSession 对象，支持链式调用。
- Defined in watcher.ts:523

off

off(): void
取消所有通过当前 WatchSession 对象设置的监听。

Returns void
- Defined in watcher.ts:551

watch

watch<T, K, V>(object, property, handler, thisObject?, onlyChanged?, topObject?, fullProperty?): WatchSession
监听对象的某个属性变化。
Type Parameters
- T
- K extends string | number | symbol
- V
Parameters
- object: T
  
  要监听的对象。
- property: K
  
  要监听的属性名。
- handler: ((newValue, oldValue, object, property) => void)
  
  属性变化时的回调函数。
  - - (newValue, oldValue, object, property): void
    - Parameters
      
      newValue: V
      
      oldValue: V
      
      object: T
      
      property: string
      
      Returns void
- Optional thisObject: any
  
  回调函数的上下文对象。
- Optional onlyChanged: boolean
  
  是否仅在属性值变化时触发回调，默认为 true。
- Optional topObject: any
  
  顶层对象，用于链式监听。
- Optional fullProperty: string
  
  完整属性路径，用于链式监听。
Returns WatchSession
返回当前的 WatchSession 对象，支持链式调用。
- Defined in watcher.ts:502

watchchain

watchchain(object, property, handler, thisObject?, onlyChanged?, topObject?, fullProperty?): WatchSession
监听对象属性的链式变化。
Parameters
- object: any
  
  要监听的对象。
- property: string
  
  要监听的属性名。
- handler: ((newValue, oldValue, object, property) => void)
  
  属性变化时的回调函数。
  - - (newValue, oldValue, object, property): void
    - Parameters
      
      newValue: any
      
      oldValue: any
      
      object: any
      
      property: string
      
      Returns void
- Optional thisObject: any
  
  回调函数的上下文对象。
- Optional onlyChanged: boolean
  
  是否仅在属性值变化时触发回调，默认为 true。
- Optional topObject: any
  
  顶层对象，用于链式监听。
- Optional fullProperty: string
  
  完整属性路径，用于链式监听。
Returns WatchSession
返回当前的 WatchSession 对象，支持链式调用。
- Defined in watcher.ts:536

watchobject

watchobject<T>(object, property, handler, thisObject?, onlyChanged?): WatchSession
监听对象的整个对象变化。
Type Parameters
- T
Parameters
- object: T
  
  要监听的对象。
- property: gPartial<T>
  
  要监听的属性名。
- handler: ((newValue, oldValue, host, property) => void)
  
  属性变化时的回调函数。
  - - (newValue, oldValue, host, property): void
    - Parameters
      
      newValue: any
      
      oldValue: any
      
      host: any
      
      property: string
      
      Returns void
- Optional thisObject: any
  
  回调函数的上下文对象。
- Optional onlyChanged: boolean
  
  是否仅在属性值变化时触发回调，默认为 true。
Returns WatchSession
返回当前的 WatchSession 对象，支持链式调用。
- Defined in watcher.ts:547

watchs

watchs<T, K, V>(object, propertys, handler, thisObject?, onlyChanged?): WatchSession
监听对象的多个属性变化。
Type Parameters
- T
- K extends string | number | symbol
- V
Parameters
- object: T
  
  要监听的对象。
- propertys: K[]
  
  要监听的属性名数组。
- handler: ((newValue, oldValue, object, property) => void)
  
  属性变化时的回调函数。
  - - (newValue, oldValue, object, property): void
    - Parameters
      
      newValue: V
      
      oldValue: V
      
      object: T
      
      property: string
      
      Returns void
- Optional thisObject: any
  
  回调函数的上下文对象。
- Optional onlyChanged: boolean
  
  是否仅在属性值变化时触发回调，默认为 true。
Returns WatchSession
返回当前的 WatchSession 对象，支持链式调用。
- Defined in watcher.ts:513

Interface WatchSession

Hierarchy

Index

Methods

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 WatchSession

off

Returns void

watch

Type Parameters

T

K extends string | number | symbol

V

Parameters

object: T

property: K

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

Parameters

newValue: V

oldValue: V

object: T

property: string

Returns void

Optional thisObject: any

Optional onlyChanged: boolean

Optional topObject: any

Optional fullProperty: string

Returns WatchSession

watchchain

Parameters

object: any

property: string

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

Parameters

newValue: any

oldValue: any

object: any

property: string

Returns void

Optional thisObject: any

Optional onlyChanged: boolean

Optional topObject: any

Optional fullProperty: string

Returns WatchSession

watchobject

Type Parameters

T

Parameters

object: T

property: gPartial<T>

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

Parameters

newValue: any

oldValue: any

host: any

property: string

Returns void

Optional thisObject: any

Optional onlyChanged: boolean

Returns WatchSession

watchs

Type Parameters

T

K extends string | number | symbol

V

Parameters

object: T

propertys: K[]

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

`Optional` thisObject: any

`Optional` onlyChanged: boolean

`Optional` topObject: any

`Optional` fullProperty: string

`Optional` thisObject: any

`Optional` onlyChanged: boolean

`Optional` topObject: any

`Optional` fullProperty: string

`Optional` thisObject: any

`Optional` onlyChanged: boolean

`Optional` thisObject: any

`Optional` onlyChanged: boolean