@tresjs/post-processing/dist/util/prop.d.ts

Post-processing library for TresJS

import { Ref, WatchOptions } from 'vue';
/**
 * Creates a prop watcher function that monitors changes to a property and updates a target object.
 *
 * @template T - The type of the property being watched.
 * @template E - The type of the target object.
 * @param {() => T} propGetter - A function that retrieves the prop value to be watched.
 * @param {Ref<E>} target - A Ref representing the target object to be updated.
 * @param {string} propertyPath - The dot-separated path to the property within the target object.
 * @param {() => E & { dispose?(): void }} newPlainObjectFunction - A function that creates a new plain object to retrieve the defaults from with an optional "dispose" method for cleanup.
 * @param {WatchOptions} watchOptions - The options for watch.
 */
export declare const makePropWatcher: <T, E>(propGetter: () => T, target: Ref<E>, propertyPath: string, newPlainObjectFunction: () => E & {
    dispose?: () => void;
}, watchOptions?: WatchOptions) => import('vue').WatchHandle;
/**
 * Creates multiple prop watchers for monitoring changes to multiple properties and updating a target object.
 *
 * @template T - The type of the property being watched.
 * @template E - The type of the target object.
 * @param {(string | (() => T))[][]} propGettersAndPropertyPaths - An array of arrays containing pairs of prop getters and their corresponding property paths within the target object.
 * @param {Ref<E>} target - A Ref representing the target object to be updated.
 * @param {() => E & { dispose?(): void }} newPlainObjectFunction - A function that creates a new plain object to retrieve the defaults from with an optional "dispose" method for cleanup.
 */
export declare const makePropWatchers: <E>(propGettersAndPropertyPaths: (string | (() => any))[][], target: Ref<E>, newPlainObjectFunction: () => E & {
    dispose?: () => void;
}) => import('vue').WatchHandle[];
/**
 * Creates multiple prop watchers via the props object for monitoring changes to multiple properties and updating a target object.
 * Use this method in case the prop names match the names of the properties you want to set on your target object.
 *
 * @param props - The props object. Usually created via defineProps.
 * @param {Ref<E>} target - A Ref representing the target object to be updated.
 * @param {() => E & { dispose?(): void }} newPlainObjectFunction - A function that creates a new plain object to retrieve the defaults from with an optional "dispose" method for cleanup.
 */
export declare const makePropWatchersUsingAllProps: <E>(props: {
    [key: PropertyKey]: any;
}, target: Ref<E>, newPlainObjectFunction: () => E & {
    dispose?: () => void;
}) => import('vue').WatchHandle[];