@types/three/src/renderers/common/DataMap.d.ts

TypeScript definitions for three

/**
 * Data structure for the renderer. It is intended to manage
 * data of objects in dictionaries.
 *
 * @private
 */
declare class DataMap {
    /**
     * `DataMap` internally uses a weak map
     * to manage its data.
     *
     * @type {WeakMap<Object, Object>}
     */
    data: WeakMap<object, unknown>;
    /**
     * Returns the dictionary for the given object.
     *
     * @param {Object} object - The object.
     * @return {Object} The dictionary.
     */
    get(object: object): unknown;
    /**
     * Deletes the dictionary for the given object.
     *
     * @param {Object} object - The object.
     * @return {?Object} The deleted dictionary.
     */
    delete(object: object): unknown | null;
    /**
     * Returns `true` if the given object has a dictionary defined.
     *
     * @param {Object} object - The object to test.
     * @return {boolean} Whether a dictionary is defined or not.
     */
    has(object: object): boolean;
    /**
     * Frees internal resources.
     */
    dispose(): void;
}

export default DataMap;