@types/three 0.150.1 → 0.151.0

three/src/helpers/Box3Helper.d.ts

@@ -2,19 +2,43 @@ import { Box3 } from './../math/Box3';
 import { Color } from './../math/Color';
 import { LineSegments } from './../objects/LineSegments';
 
+/**
+ * Helper object to visualize a {@link THREE.Box3 | Box3}.
+ * @example
+ * ```typescript
+ * const box = new THREE.Box3();
+ * box.setFromCenterAndSize(new THREE.Vector3(1, 1, 1), new THREE.Vector3(2, 1, 3));
+ * const helper = new THREE.Box3Helper(box, 0xffff00);
+ * scene.add(helper);
+ * ```
+ * @see {@link https://threejs.org/docs/index.html#api/en/helpers/Box3Helper | Official Documentation}
+ * @see {@link https://github.com/mrdoob/three.js/blob/master/src/helpers/Box3Helper.js | Source}
+ */
 export class Box3Helper extends LineSegments {
     /**
-     * @param box
-     * @param [color=0xffff00]
+     * Creates a new wireframe box that represents the passed Box3.
+     * @param box The Box3 to show.
+     * @param color The box's color. Default `0xffff00`
      */
     constructor(box: Box3, color?: Color);
 
     /**
-     * @default 'Box3Helper'
+     * A Read-only _string_ to check if `this` object type.
+     * @remarks Sub-classes will update this value.
+     * @override
+     * @defaultValue `Box3Helper`
      */
-    type: string;
+    override readonly type: string | 'Box3Helper';
 
+    /**
+     * The Box3 being visualized.
+     */
     box: Box3;
 
+    /**
+     * Frees the GPU-related resources allocated by this instance
+     * @remarks
+     * Call this method whenever this instance is no longer used in your app.
+     */
     dispose(): void;
 }

three/src/helpers/BoxHelper.d.ts

@@ -1,22 +1,62 @@
-import { ColorRepresentation } from '../utils';
+import { ColorRepresentation } from '../math/Color';
 import { Object3D } from './../core/Object3D';
 import { LineSegments } from './../objects/LineSegments';
 
+/**
+ * Helper object to graphically show the world-axis-aligned bounding box around an object
+ * @remarks
+ * The actual bounding box is handled with {@link THREE.Box3 | Box3}, this is just a visual helper for debugging
+ * It can be automatically resized with the {@link THREE.BoxHelper.update | BoxHelper.update} method when the object it's created from is transformed
+ * Note that the object must have a {@link THREE.BufferGeometry | BufferGeometry} for this to work, so it won't work with {@link Sprite | Sprites}.
+ * @example
+ * ```typescript
+ * const sphere = new THREE.SphereGeometry();
+ * const object = new THREE.Mesh(sphere, new THREE.MeshBasicMaterial(0xff0000));
+ * const box = new THREE.BoxHelper(object, 0xffff00);
+ * scene.add(box);
+ * ```
+ * @see Example: {@link https://threejs.org/examples/#webgl_helpers | WebGL / helpers}
+ * @see Example: {@link https://threejs.org/examples/#webgl_loader_nrrd | WebGL / loader / nrrd}
+ * @see Example: {@link https://threejs.org/examples/#webgl_buffergeometry_drawrange | WebGL / buffergeometry / drawrange}
+ * @see {@link https://threejs.org/docs/index.html#api/en/helpers/BoxHelper | Official Documentation}
+ * @see {@link https://github.com/mrdoob/three.js/blob/master/src/helpers/BoxHelper.js | Source}
+ */
 export class BoxHelper extends LineSegments {
     /**
-     * @param object
-     * @param [color=0xffff00]
+     * Creates a new wireframe box that bounds the passed object
+     * @remarks
+     * Internally this uses {@link THREE.Box3.setFromObject | Box3.setFromObject} to calculate the dimensions
+     * Note that this includes any children.
+     * @param object The object3D to show the world-axis-aligned bounding box.
+     * @param color Hexadecimal value that defines the box's color. Default `0xffff00`
      */
     constructor(object: Object3D, color?: ColorRepresentation);
 
     /**
-     * @default 'BoxHelper'
+     * A Read-only _string_ to check if `this` object type.
+     * @remarks Sub-classes will update this value.
+     * @override
+     * @defaultValue `BoxHelper`
      */
-    type: string;
+    override readonly type: string | 'BoxHelper';
 
+    /**
+     * Updates the helper's geometry to match the dimensions of the object, including any children
+     * @remarks
+     * See {@link THREE.Box3.setFromObject | Box3.setFromObject}.
+     */
     update(object?: Object3D): void;
 
+    /**
+     * Updates the wireframe box for the passed object.
+     * @param object {@link THREE.Object3D | Object3D} to create the helper of.
+     */
     setFromObject(object: Object3D): this;
 
+    /**
+     * Frees the GPU-related resources allocated by this instance
+     * @remarks
+     * Call this method whenever this instance is no longer used in your app.
+     */
     dispose(): void;
 }

three/src/helpers/CameraHelper.d.ts

@@ -4,19 +4,36 @@ import { Camera } from './../cameras/Camera';
 import { LineSegments } from './../objects/LineSegments';
 
 /**
- * This helps with visualizing what a camera contains in its frustum.
- * It visualizes the frustum of a camera using a {@link LineSegments}.
- *
- * CameraHelper must be a child of the scene.
+ * This helps with visualizing what a camera contains in its frustum
+ * @remarks
+ * It visualizes the frustum of a camera using a {@link THREE.LineSegments | LineSegments}.
+ * @remarks {@link CameraHelper} must be a child of the scene.
+ * @example
+ * ```typescript
+ * const camera = new THREE.PerspectiveCamera(75, window.innerWidth / window.innerHeight, 0.1, 1000);
+ * const helper = new THREE.CameraHelper(camera);
+ * scene.add(helper);
+ * ```
+ * @see Example: {@link https://threejs.org/examples/#webgl_camera | WebGL / camera}
+ * @see Example: {@link https://threejs.org/examples/#webgl_geometry_extrude_splines | WebGL / extrude / splines}
+ * @see {@link https://threejs.org/docs/index.html#api/en/helpers/CameraHelper | Official Documentation}
+ * @see {@link https://github.com/mrdoob/three.js/blob/master/src/helpers/CameraHelper.js | Source}
  */
 export class CameraHelper extends LineSegments {
     /**
-     * This create a new CameraHelper for the specified camera.
-     *
-     * @param camera - The camera to visualize.
+     * This create a new {@link CameraHelper} for the specified camera.
+     * @param camera The camera to visualize.
      */
     constructor(camera: Camera);
 
+    /**
+     * A Read-only _string_ to check if `this` object type.
+     * @remarks Sub-classes will update this value.
+     * @override
+     * @defaultValue `CameraHelper`
+     */
+    override readonly type: string | 'CameraHelper';
+
     /**
      * The camera being visualized.
      */
@@ -28,20 +45,26 @@ export class CameraHelper extends LineSegments {
     pointMap: { [id: string]: number[] };
 
     /**
-     * Reference to the {@link Camera.matrixWorld}.
+     * Reference to the {@link THREE.Camera.matrixWorld | camera.matrixWorld}.
      */
     matrix: Matrix4;
 
     /**
-     * See {@link Object3D.matrixAutoUpdate}.
-     * Set to `false` here as the helper is using the camera's {@link Camera.matrixWorld}.
+     * Is set to `false`, as the helper is using the {@link THREE.Camera.matrixWorld | camera.matrixWorld}.
+     * @see {@link THREE.Object3D.matrixAutoUpdate | Object3D.matrixAutoUpdate}.
+     * @defaultValue `false`.
      */
-    matrixAutoUpdate: boolean;
+    override matrixAutoUpdate: boolean;
 
     /**
-     * @default 'CameraHelper'
+     * Defines the colors of the helper.
+     * @param frustum
+     * @param cone
+     * @param up
+     * @param target
+     * @param cross
      */
-    type: string;
+    setColors(frustum: Color, cone: Color, up: Color, target: Color, cross: Color): this;
 
     /**
      * Updates the helper based on the projectionMatrix of the camera.
@@ -49,13 +72,9 @@ export class CameraHelper extends LineSegments {
     update(): void;
 
     /**
-     * Frees the GPU-related resources allocated by this instance.
+     * Frees the GPU-related resources allocated by this instance
+     * @remarks
      * Call this method whenever this instance is no longer used in your app.
      */
     dispose(): void;
-
-    /**
-     * Defines the colors of the helper.
-     */
-    setColors(frustum: Color, cone: Color, up: Color, target: Color, cross: Color): this;
 }

three/src/helpers/DirectionalLightHelper.d.ts

@@ -2,31 +2,78 @@ import { DirectionalLight } from './../lights/DirectionalLight';
 import { Line } from './../objects/Line';
 import { Matrix4 } from './../math/Matrix4';
 import { Object3D } from './../core/Object3D';
-import { ColorRepresentation } from '../utils';
+import { ColorRepresentation } from '../math/Color';
 
+/**
+ * Helper object to assist with visualizing a {@link THREE.DirectionalLight | DirectionalLight}'s effect on the scene
+ * @remarks
+ * This consists of plane and a line representing the light's position and direction.
+ * @example
+ * ```typescript
+ * const light = new THREE.DirectionalLight(0xFFFFFF);
+ * const helper = new THREE.DirectionalLightHelper(light, 5);
+ * scene.add(helper);
+ * ```
+ * @see {@link https://threejs.org/docs/index.html#api/en/helpers/DirectionalLightHelper | Official Documentation}
+ * @see {@link https://github.com/mrdoob/three.js/blob/master/src/helpers/DirectionalLightHelper.js | Source}
+ */
 export class DirectionalLightHelper extends Object3D {
     /**
-     * @param light
-     * @param [size=1]
-     * @param color
+     * Create a new instance of {@link DirectionalLightHelper}
+     * @param light The light to be visualized.
+     * @param size Dimensions of the plane. Default `1`
+     * @param color If this is not the set the helper will take the color of the light. Default `light.color`
      */
     constructor(light: DirectionalLight, size?: number, color?: ColorRepresentation);
 
-    light: DirectionalLight;
+    /**
+     * A Read-only _string_ to check if `this` object type.
+     * @remarks Sub-classes will update this value.
+     * @override
+     * @defaultValue `DirectionalLightHelper`
+     */
+    override readonly type: string | 'DirectionalLightHelper';
+
+    /**
+     * Contains the line mesh showing the location of the directional light.
+     */
     lightPlane: Line;
-    targetLine: Line;
 
     /**
-     * @default undefined
+     * Reference to the {@link THREE.DirectionalLight | directionalLight} being visualized.
+     */
+    light: DirectionalLight;
+
+    /**
+     * Reference to the {@link THREE.DirectionalLight.matrixWorld | light.matrixWorld}.
      */
-    color: ColorRepresentation | undefined;
     matrix: Matrix4;
 
     /**
-     * @default false
+     * Is set to `false`, as the helper is using the {@link THREE.DirectionalLight.matrixWorld | light.matrixWorld}.
+     * @see {@link THREE.Object3D.matrixAutoUpdate | Object3D.matrixAutoUpdate}.
+     * @defaultValue `false`.
      */
-    matrixAutoUpdate: boolean;
+    override matrixAutoUpdate: boolean;
 
-    dispose(): void;
+    /**
+     * The color parameter passed in the constructor.
+     * @remarks If this is changed, the helper's color will update the next time {@link update} is called.
+     * @defaultValue `undefined`
+     */
+    color: ColorRepresentation | undefined;
+
+    targetLine: Line; // TODO: Double check if this need to be exposed or not.
+
+    /**
+     * Updates the helper to match the position and direction of the {@link light | DirectionalLight} being visualized.
+     */
     update(): void;
+
+    /**
+     * Frees the GPU-related resources allocated by this instance
+     * @remarks
+     * Call this method whenever this instance is no longer used in your app.
+     */
+    dispose(): void;
 }

three/src/helpers/GridHelper.d.ts

@@ -1,19 +1,45 @@
-import { ColorRepresentation } from '../utils';
+import { ColorRepresentation } from '../math/Color';
 import { LineSegments } from './../objects/LineSegments';
 
+/**
+ * The {@link GridHelper} is an object to define grids
+ * @remarks
+ * Grids are two-dimensional arrays of lines.
+ * @example
+ * ```typescript
+ * const size = 10;
+ * const divisions = 10;
+ * const {@link GridHelper} = new THREE.GridHelper(size, divisions);
+ * scene.add(gridHelper);
+ * ```
+ * @see Example: {@link https://threejs.org/examples/#webgl_helpers | WebGL / helpers}
+ * @see {@link https://threejs.org/docs/index.html#api/en/helpers/GridHelper | Official Documentation}
+ * @see {@link https://github.com/mrdoob/three.js/blob/master/src/helpers/GridHelper.js | Source}
+ */
 export class GridHelper extends LineSegments {
     /**
-     * @param [size=10]
-     * @param [divisions=10]
-     * @param [color1=0x444444]
-     * @param [color2=0x888888]
+     * Creates a new {@link GridHelper} of size 'size' and divided into 'divisions' segments per side
+     * @remarks
+     * Colors are optional.
+     * @param size The size of the grid. Default `10`
+     * @param divisions The number of divisions across the grid. Default `10`
+     * @param colorCenterLine The color of the centerline. This can be a {@link THREE.Color | Color}, a hexadecimal value and an CSS-Color name. Default `0x444444`
+     * @param colorGrid The color of the lines of the grid. This can be a {@link THREE.Color | Color}, a hexadecimal value and an CSS-Color name. Default `0x888888`
      */
     constructor(size?: number, divisions?: number, color1?: ColorRepresentation, color2?: ColorRepresentation);
 
     /**
-     * @default 'GridHelper'
+     * A Read-only _string_ to check if `this` object type.
+     * @remarks Sub-classes will update this value.
+     * @override
+     * @defaultValue `GridHelper`
      */
-    type: string;
+    override readonly type: string | 'GridHelper';
 
+    /**
+     * Frees the GPU-related resources allocated by this instance
+     * @remarks
+     * Call this method whenever this instance is no longer used in your app.
+     */
     dispose(): void;
 }

three/src/helpers/HemisphereLightHelper.d.ts

@@ -1,20 +1,72 @@
 import { HemisphereLight } from './../lights/HemisphereLight';
-import { Color } from './../math/Color';
 import { Matrix4 } from './../math/Matrix4';
 import { MeshBasicMaterial } from './../materials/MeshBasicMaterial';
 import { Object3D } from './../core/Object3D';
-import { ColorRepresentation } from '../utils';
+import { ColorRepresentation } from '../math/Color';
 
+/**
+ * Creates a visual aid consisting of a spherical {@link THREE.Mesh | Mesh} for a {@link THREE.HemisphereLight | HemisphereLight}.
+ * @example
+ * ```typescript
+ * const light = new THREE.HemisphereLight(0xffffbb, 0x080820, 1);
+ * const helper = new THREE.HemisphereLightHelper(light, 5);
+ * scene.add(helper);
+ * ```
+ * @see {@link https://threejs.org/docs/index.html#api/en/helpers/HemisphereLightHelper | Official Documentation}
+ * @see {@link https://github.com/mrdoob/three.js/blob/master/src/helpers/HemisphereLightHelper.js | Source}
+ */
 export class HemisphereLightHelper extends Object3D {
+    /**
+     *  Create a new instance of {@link HemisphereLightHelper}
+     * @param light The light being visualized.
+     * @param size Thr sphere size
+     * @param color If this is not the set the helper will take the color of the light.
+     */
     constructor(light: HemisphereLight, size: number, color?: ColorRepresentation);
 
+    /**
+     * A Read-only _string_ to check if `this` object type.
+     * @remarks Sub-classes will update this value.
+     * @override
+     * @defaultValue `HemisphereLightHelper`
+     */
+    override readonly type: string | 'HemisphereLightHelper';
+
+    /**
+     * Reference to the HemisphereLight being visualized.
+     */
     light: HemisphereLight;
+
+    /**
+     * Reference to the {@link THREE.HemisphereLight.matrixWorld | light.matrixWorld}.
+     */
     matrix: Matrix4;
-    matrixAutoUpdate: boolean;
-    material: MeshBasicMaterial;
 
+    /**
+     * Is set to `false`, as the helper is using the {@link THREE.HemisphereLight.matrixWorld | light.matrixWorld}.
+     * @see {@link THREE.Object3D.matrixAutoUpdate | Object3D.matrixAutoUpdate}.
+     * @defaultValue `false`.
+     */
+    override matrixAutoUpdate: boolean;
+
+    material: MeshBasicMaterial; // TODO: Double check if this need to be exposed or not.
+
+    /**
+     * The color parameter passed in the constructor.
+     * @remarks If this is changed, the helper's color will update the next time {@link update} is called.
+     * @defaultValue `undefined`
+     */
     color: ColorRepresentation | undefined;
 
-    dispose(): void;
+    /**
+     * Updates the helper to match the position and direction of the {@link .light | HemisphereLight}.
+     */
     update(): void;
+
+    /**
+     * Frees the GPU-related resources allocated by this instance
+     * @remarks
+     * Call this method whenever this instance is no longer used in your app.
+     */
+    dispose(): void;
 }

three/src/helpers/PlaneHelper.d.ts

@@ -1,27 +1,50 @@
 import { Plane } from './../math/Plane';
 import { LineSegments } from './../objects/LineSegments';
 
+/**
+ * Helper object to visualize a {@link THREE.Plane | Plane}.
+ * @example
+ * ```typescript
+ * const plane = new THREE.Plane(new THREE.Vector3(1, 1, 0.2), 3);
+ * const helper = new THREE.PlaneHelper(plane, 1, 0xffff00);
+ * scene.add(helper);
+ * ```
+ * @see {@link https://threejs.org/docs/index.html#api/en/helpers/PlaneHelper | Official Documentation}
+ * @see {@link https://github.com/mrdoob/three.js/blob/master/src/helpers/PlaneHelper.js | Source}
+ */
 export class PlaneHelper extends LineSegments {
     /**
-     * @param plane
-     * @param [size=1]
-     * @param [hex=0xffff00]
+     * Creates a new wireframe representation of the passed plane.
+     * @param plane The plane to visualize.
+     * @param size Side length of plane helper. Expects a `Float`. Default `1`
+     * @param hex Color. Default `0xffff00`
      */
     constructor(plane: Plane, size?: number, hex?: number);
 
     /**
-     * @default 'PlaneHelper'
+     * A Read-only _string_ to check if `this` object type.
+     * @remarks Sub-classes will update this value.
+     * @override
+     * @defaultValue `PlaneHelper`
      */
-    type: string;
+    override readonly type: string | 'PlaneHelper';
 
+    /**
+     * The {@link Plane | plane} being visualized.
+     */
     plane: Plane;
 
     /**
-     * @default 1
+     * The side lengths of plane helper.
+     * @remarks Expects a `Float`
+     * @defaultValue `1`
      */
     size: number;
 
-    updateMatrixWorld(force?: boolean): void;
-
+    /**
+     * Frees the GPU-related resources allocated by this instance
+     * @remarks
+     * Call this method whenever this instance is no longer used in your app.
+     */
     dispose(): void;
 }

three/src/helpers/PointLightHelper.d.ts

@@ -1,25 +1,73 @@
 import { PointLight } from './../lights/PointLight';
 import { Matrix4 } from './../math/Matrix4';
 import { Object3D } from './../core/Object3D';
-import { ColorRepresentation } from '../utils';
+import { ColorRepresentation } from '../math/Color';
 
+/**
+ * This displays a helper object consisting of a spherical {@link THREE.Mesh | Mesh} for visualizing a {@link THREE.PointLight | PointLight}.
+ * @example
+ * ```typescript
+ * const pointLight = new THREE.PointLight(0xff0000, 1, 100);
+ * pointLight.position.set(10, 10, 10);
+ * scene.add(pointLight);
+ * const sphereSize = 1;
+ * const {@link PointLightHelper} = new THREE.PointLightHelper(pointLight, sphereSize);
+ * scene.add(pointLightHelper);
+ * ```
+ * @see Example: {@link https://threejs.org/examples/#webgl_helpers | WebGL / helpers}
+ * @see {@link https://threejs.org/docs/index.html#api/en/helpers/PointLightHelper | Official Documentation}
+ * @see {@link https://github.com/mrdoob/three.js/blob/master/src/helpers/PointLightHelper.js | Source}
+ */
 export class PointLightHelper extends Object3D {
+    /**
+     * Create a new instance of {@link PointLightHelper}
+     * @param light The light to be visualized.
+     * @param sphereSize The size of the sphere helper. Expects a `Float`. Default `1`
+     * @param color If this is not the set the helper will take the color of the light.
+     */
     constructor(light: PointLight, sphereSize?: number, color?: ColorRepresentation);
 
     /**
-     * @default 'PointLightHelper'
+     * A Read-only _string_ to check if `this` object type.
+     * @remarks Sub-classes will update this value.
+     * @override
+     * @defaultValue `PointLightHelper`
      */
-    type: string;
+    override readonly type: string | 'PointLightHelper';
 
+    /**
+     * The {@link THREE.PointLight | PointLight} that is being visualized.
+     */
     light: PointLight;
-    color: ColorRepresentation | undefined;
+
+    /**
+     * Reference to the {@link THREE.PointLight.matrixWorld | light.matrixWorld}.
+     */
     matrix: Matrix4;
 
     /**
-     * @default false
+     * The color parameter passed in the constructor.
+     * @remarks If this is changed, the helper's color will update the next time {@link update} is called.
+     * @defaultValue `undefined`
      */
-    matrixAutoUpdate: boolean;
+    color: ColorRepresentation | undefined;
 
-    dispose(): void;
+    /**
+     * Is set to `false`, as the helper is using the {@link THREE.PointLight.matrixWorld | light.matrixWorld}.
+     * @see {@link THREE.Object3D.matrixAutoUpdate | Object3D.matrixAutoUpdate}.
+     * @defaultValue `false`.
+     */
+    override matrixAutoUpdate: boolean;
+
+    /**
+     * Updates the helper to match the position of the {@link THREE..light | .light}.
+     */
     update(): void;
+
+    /**
+     * Frees the GPU-related resources allocated by this instance
+     * @remarks
+     * Call this method whenever this instance is no longer used in your app.
+     */
+    dispose(): void;
 }

three/src/helpers/PolarGridHelper.d.ts

@@ -1,14 +1,33 @@
 import { LineSegments } from '../objects/LineSegments';
-import { ColorRepresentation } from '../utils';
+import { ColorRepresentation } from '../math/Color';
 
+/**
+ * The {@link PolarGridHelper} is an object to define polar grids
+ * @remarks
+ * Grids are two-dimensional arrays of lines.
+ * @example
+ * ```typescript
+ * const radius = 10;
+ * const sectors = 16;
+ * const rings = 8;
+ * const divisions = 64;
+ * const helper = new THREE.PolarGridHelper(radius, sectors, rings, divisions);
+ * scene.add(helper);
+ * ```
+ * @see Example: {@link https://threejs.org/examples/#webgl_helpers | WebGL / helpers}
+ * @see {@link https://threejs.org/docs/index.html#api/en/helpers/PolarGridHelper | Official Documentation}
+ * @see {@link https://github.com/mrdoob/three.js/blob/master/src/helpers/PolarGridHelper.js | Source}
+ */
 export class PolarGridHelper extends LineSegments {
     /**
-     * @param [radius=10]
-     * @param [radials=16]
-     * @param [circles=8]
-     * @param [divisions=64]
-     * @param [color1=0x444444]
-     * @param [color2=0x888888]
+     * Creates a new {@link PolarGridHelper} of radius 'radius' with 'sectors' number of sectors and 'rings' number of rings, where each circle is smoothed into 'divisions' number of line segments.
+     * @remarks Colors are optional.
+     * @param radius The radius of the polar grid. This can be any positive number. Default `10`.
+     * @param sectors The number of sectors the grid will be divided into. This can be any positive integer. Default `16`.
+     * @param rings The number of rings. This can be any positive integer. Default `8`.
+     * @param divisions The number of line segments used for each circle. This can be any positive integer that is 3 or greater. Default `64`.
+     * @param color1 The first color used for grid elements. This can be a {@link THREE.Color | Color}, a hexadecimal value and an CSS-Color name. Default `0x444444`.
+     * @param color2 The second color used for grid elements. This can be a {@link THREE.Color | Color}, a hexadecimal value and an CSS-Color name. Default `0x888888`.
      */
     constructor(
         radius?: number,
@@ -20,9 +39,17 @@ export class PolarGridHelper extends LineSegments {
     );
 
     /**
-     * @default 'PolarGridHelper'
+     * A Read-only _string_ to check if `this` object type.
+     * @remarks Sub-classes will update this value.
+     * @override
+     * @defaultValue `PolarGridHelper`
      */
-    type: string;
+    override readonly type: string | 'PolarGridHelper';
 
+    /**
+     * Frees the GPU-related resources allocated by this instance
+     * @remarks
+     * Call this method whenever this instance is no longer used in your app.
+     */
     dispose(): void;
 }