Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface WatchHandlerParams

Extended parameters of a mutation event

Hierarchy

Index

Properties

Properties

fromProto

fromProto: boolean

True if the mutation has occurred on a prototype of the watched object

obj

obj: object

Link to the object that is watched

originalPath

originalPath: unknown[]

The original path to a property that was changed.

example
function pathModifier(path) {
  return path.map((chunk) => chunk.replace(/^_/, ''));
}

const {proxy} = watch(a: 1, b: 2, _a: 1}, 'a', {pathModifier}, (mutations) => {
  mutations.forEach(([value, oldValue, info]) => {
    console.log(value, oldValue, info.path, info.originalPath);
  });
});

// 2 1 ['a'], ['_a']
proxy._a = 2;

Optional parent

parent?: WatchHandlerParentParams

Information about the parent mutation event

path

path: unknown[]

Path to a property that was changed

root

root: object

Link to the root object of watching

Optional top

top?: object

Link to the top property of watching (the first level property of the root)