Module src/core/object/watch/engines/proxy

Index

Functions

Functions

set

set(obj: object, path: ObjectPropertyPath, value: unknown, handlers: WatchHandlersSet): void

- Defined in src/core/object/watch/engines/proxy.ts:434
Sets a new watchable value for an object by the specified path

Parameters
- obj: object
- path: ObjectPropertyPath
- value: unknown
- handlers: WatchHandlersSet
  
  set of registered handlers
Returns void

unset

unset(obj: object, path: ObjectPropertyPath, handlers: WatchHandlersSet): void

- Defined in src/core/object/watch/engines/proxy.ts:495
Deletes a watchable value for an object by the specified path

Parameters
- obj: object
- path: ObjectPropertyPath
- handlers: WatchHandlersSet
  
  set of registered handlers
Returns void

watch

watch<T>(obj: T, path: CanUndef<unknown[]>, handler: Nullable<RawWatchHandler<unknown, unknown>>, handlers: WatchHandlersSet, opts?: WatchOptions): Watcher<T>
watch<T>(obj: T, path: CanUndef<unknown[]>, handler: Nullable<RawWatchHandler<unknown, unknown>>, handlers: WatchHandlersSet, opts: CanUndef<InternalWatchOptions>, root: object, top: object): T

- Defined in src/core/object/watch/engines/proxy.ts:59
Watches for changes of the specified object by using Proxy objects

Type parameters
- T: object
Parameters
- obj: T
- path: CanUndef<unknown[]>
  
  base path to object properties: it is provided to a watch handler with parameters
- handler: Nullable<RawWatchHandler<unknown, unknown>>
  
  callback that is invoked on every mutation hook
- handlers: WatchHandlersSet
  
  set of registered handlers
- Optional opts: WatchOptions
Returns Watcher<T>
- Defined in src/core/object/watch/engines/proxy.ts:78
Watches for changes of the specified object by using Proxy objects

Type parameters
- T: object
Parameters
- obj: T
- path: CanUndef<unknown[]>
  
  base path to object properties: it is provided to a watch handler with parameters
- handler: Nullable<RawWatchHandler<unknown, unknown>>
  
  callback that is invoked on every mutation hook
- handlers: WatchHandlersSet
  
  set of registered handlers
- opts: CanUndef<InternalWatchOptions>
  
  additional options
- root: object
  
  link to the root object of watching
- top: object
  
  link to the top object of watching
Returns T