@types/three 0.150.2 → 0.151.0

three/src/extras/curves/CubicBezierCurve3.d.ts

@@ -1,31 +1,72 @@
 import { Vector3 } from './../../math/Vector3';
 import { Curve } from './../core/Curve';
 
+/**
+ * Create a smooth **3D** {@link http://en.wikipedia.org/wiki/B%C3%A9zier_curve#mediaviewer/File:Bezier_curve.svg | cubic bezier curve},
+ * defined by a start point, endpoint and two control points.
+ * @example
+ * ```typescript
+ * const curve = new THREE.CubicBezierCurve(
+ * new THREE.Vector2(-10, 0),
+ * new THREE.Vector2(-5, 15),
+ * new THREE.Vector2(20, 15),
+ * new THREE.Vector2(10, 0));
+ * const points = curve.getPoints(50);
+ * const geometry = new THREE.BufferGeometry().setFromPoints(points);
+ * const material = new THREE.LineBasicMaterial({
+ *     color: 0xff0000
+ * });
+ * // Create the final object to add to the scene
+ * const curveObject = new THREE.Line(geometry, material);
+ * ```
+ * @see {@link https://threejs.org/docs/index.html#api/en/extras/curves/CubicBezierCurve | Official Documentation}
+ * @see {@link https://github.com/mrdoob/three.js/blob/master/src/extras/curves/CubicBezierCurve.js | Source}
+ */
 export class CubicBezierCurve3 extends Curve<Vector3> {
-    constructor(v0: Vector3, v1: Vector3, v2: Vector3, v3: Vector3);
+    /**
+     * This constructor creates a new {@link CubicBezierCurve3}.
+     * @param v0 The starting point. Default is `new THREE.Vector3()`.
+     * @param v1 The first control point. Default is `new THREE.Vector3()`.
+     * @param v2 The second control point. Default is `new THREE.Vector3()`.
+     * @param v3 The ending point. Default is `new THREE.Vector3()`.
+     */
+    constructor(v0?: Vector3, v1?: Vector3, v2?: Vector3, v3?: Vector3);
+
+    /**
+     * Read-only flag to check if a given object is of type {@link CubicBezierCurve3}.
+     * @remarks This is a _constant_ value
+     * @defaultValue `true`
+     */
+    readonly isCubicBezierCurve3 = true;
 
     /**
-     * @default 'CubicBezierCurve3'
+     * A Read-only _string_ to check if `this` object type.
+     * @remarks Sub-classes will update this value.
+     * @defaultValue `CubicBezierCurve3`
      */
-    type: string;
+    override readonly type: string | 'CubicBezierCurve3';
 
     /**
-     * @default new THREE.Vector3()
+     * The starting point.
+     * @defaultValue `new THREE.Vector3()`.
      */
     v0: Vector3;
 
     /**
-     * @default new THREE.Vector3()
+     * The first control point.
+     * @defaultValue `new THREE.Vector3()`.
      */
     v1: Vector3;
 
     /**
-     * @default new THREE.Vector3()
+     * The second control point.
+     * @defaultValue `new THREE.Vector3()`.
      */
     v2: Vector3;
 
     /**
-     * @default new THREE.Vector3()
+     * The ending point.
+     * @defaultValue `new THREE.Vector3()`.
      */
     v3: Vector3;
 }

three/src/extras/curves/EllipseCurve.d.ts

@@ -1,60 +1,115 @@
 import { Curve } from './../core/Curve';
 import { Vector2 } from '../../math/Vector2';
 
+/**
+ * Creates a 2d curve in the shape of an ellipse
+ * @remarks
+ * Setting the {@link xRadius} equal to the {@link yRadius} will result in a circle.
+ * @example
+ * ```typescript
+ * const curve = new THREE.EllipseCurve(
+ *   0,  0,  // ax, aY
+ *   10, 10, // xRadius, yRadius
+ *   0,  2 * Math.PI, // aStartAngle, aEndAngle
+ *   false,  // aClockwise
+ *   0       // aRotation
+ *   );
+ * const points = curve.getPoints(50);
+ * const geometry = new THREE.BufferGeometry().setFromPoints(points);
+ * const material = new THREE.LineBasicMaterial({ color: 0xff0000 });
+ * // Create the final object to add to the scene
+ * const ellipse = new THREE.Line(geometry, material);
+ * ```
+ * @see {@link https://threejs.org/docs/index.html#api/en/extras/curves/EllipseCurve | Official Documentation}
+ * @see {@link https://github.com/mrdoob/three.js/blob/master/src/extras/curves/EllipseCurve.js | Source}
+ */
 export class EllipseCurve extends Curve<Vector2> {
+    /**
+     * This constructor creates a new {@link EllipseCurve}.
+     * @param aX The X center of the ellipse. Expects a `Float`. Default is `0`.
+     * @param aY The Y center of the ellipse. Expects a `Float`. Default is `0`.
+     * @param xRadius The radius of the ellipse in the x direction. Expects a `Float`. Default is `1`.
+     * @param yRadius The radius of the ellipse in the y direction. Expects a `Float`. Default is `1`.
+     * @param aStartAngle The start angle of the curve in radians starting from the positive X axis. Default is `0`.
+     * @param aEndAngle The end angle of the curve in radians starting from the positive X axis. Default is `2 x Math.PI`.
+     * @param aClockwise Whether the ellipse is drawn clockwise. Default is `false`.
+     * @param aRotation The rotation angle of the ellipse in radians, counterclockwise from the positive X axis. Default is `0`.
+     */
     constructor(
-        aX: number,
-        aY: number,
-        xRadius: number,
-        yRadius: number,
-        aStartAngle: number,
-        aEndAngle: number,
-        aClockwise: boolean,
-        aRotation: number,
+        aX?: number,
+        aY?: number,
+        xRadius?: number,
+        yRadius?: number,
+        aStartAngle?: number,
+        aEndAngle?: number,
+        aClockwise?: boolean,
+        aRotation?: number,
     );
 
     /**
-     * @default 'EllipseCurve'
+     * Read-only flag to check if a given object is of type {@link EllipseCurve}.
+     * @remarks This is a _constant_ value
+     * @defaultValue `true`
+     */
+    readonly isEllipseCurve = true;
+
+    /**
+     * A Read-only _string_ to check if `this` object type.
+     * @remarks Sub-classes will update this value.
+     * @defaultValue `EllipseCurve`
      */
-    type: string;
+    override readonly type: string | 'EllipseCurve';
 
     /**
-     * @default 0
+     * The X center of the ellipse.
+     * @remarks Expects a `Float`
+     * @defaultValue `0`
      */
     aX: number;
 
     /**
-     * @default 0
+     * The Y center of the ellipse.
+     * @remarks Expects a `Float`
+     * @defaultValue `0`
      */
     aY: number;
 
     /**
-     * @default 1
+     * The radius of the ellipse in the x direction.
+     * @defaultValue `1`
      */
     xRadius: number;
 
     /**
-     * @default 1
+     * The radius of the ellipse in the y direction.
+     * @defaultValue `1`
      */
     yRadius: number;
 
     /**
-     * @default 0
+     * The start angle of the curve in radians starting from the middle right side.
+     * @remarks Expects a `Float`
+     * @defaultValue `0`
      */
     aStartAngle: number;
 
     /**
-     * @default 2 * Math.PI
+     * The end angle of the curve in radians starting from the middle right side.
+     * @remarks Expects a `Float`
+     * @defaultValue `2 * Math.PI`
      */
     aEndAngle: number;
 
     /**
-     * @default false
+     * Whether the ellipse is drawn clockwise.
+     * @defaultValue `false``
      */
     aClockwise: boolean;
 
     /**
-     * @default 0
+     * The rotation angle of the ellipse in radians, counterclockwise from the positive X axis (optional).
+     * @remarks Expects a `Float`
+     * @defaultValue `0`
      */
     aRotation: number;
 }

three/src/extras/curves/LineCurve.d.ts

@@ -1,21 +1,42 @@
 import { Vector2 } from './../../math/Vector2';
 import { Curve } from './../core/Curve';
 
+/**
+ * A curve representing a **2D** line segment.
+ * @see {@link https://threejs.org/docs/index.html#api/en/extras/curves/LineCurve | Official Documentation}
+ * @see {@link https://github.com/mrdoob/three.js/blob/master/src/extras/curves/LineCurve.js | Source}
+ */
 export class LineCurve extends Curve<Vector2> {
-    constructor(v1: Vector2, v2: Vector2);
+    /**
+     * This constructor creates a new {@link LineCurve}.
+     * @param v1 The start point. Default is `new THREE.Vector2()`.
+     * @param v2 The end point. Default is `new THREE.Vector2()`.
+     */
+    constructor(v1?: Vector2, v2?: Vector2);
+
+    /**
+     * Read-only flag to check if a given object is of type {@link LineCurve}.
+     * @remarks This is a _constant_ value
+     * @defaultValue `true`
+     */
+    readonly isLineCurve = true;
 
     /**
-     * @default 'LineCurve'
+     * A Read-only _string_ to check if `this` object type.
+     * @remarks Sub-classes will update this value.
+     * @defaultValue `LineCurve`
      */
-    type: string;
+    override readonly type: string | 'LineCurve';
 
     /**
-     * @default new THREE.Vector2()
+     * The start point.
+     * @defaultValue `new THREE.Vector2()`
      */
     v1: Vector2;
 
     /**
-     * @default new THREE.Vector2()
+     * The end point
+     * @defaultValue `new THREE.Vector2()`
      */
     v2: Vector2;
 }

three/src/extras/curves/LineCurve3.d.ts

@@ -1,21 +1,42 @@
 import { Vector3 } from './../../math/Vector3';
 import { Curve } from './../core/Curve';
 
+/**
+ * A curve representing a **3D** line segment.
+ * @see {@link https://threejs.org/docs/index.html#api/en/extras/curves/LineCurve3 | Official Documentation}
+ * @see {@link https://github.com/mrdoob/three.js/blob/master/src/extras/curves/LineCurve3.js | Source}
+ */
 export class LineCurve3 extends Curve<Vector3> {
-    constructor(v1: Vector3, v2: Vector3);
+    /**
+     * This constructor creates a new {@link LineCurve3}.
+     * @param v1 The start point. Default is `new THREE.Vector3()`.
+     * @param v2 The end point. Default is `new THREE.Vector3()`.
+     */
+    constructor(v1?: Vector3, v2?: Vector3);
+
+    /**
+     * Read-only flag to check if a given object is of type {@link LineCurve3}.
+     * @remarks This is a _constant_ value
+     * @defaultValue `true`
+     */
+    readonly isLineCurve3 = true;
 
     /**
-     * @default 'LineCurve3'
+     * A Read-only _string_ to check if `this` object type.
+     * @remarks Sub-classes will update this value.
+     * @defaultValue `LineCurve3`
      */
-    type: string;
+    override readonly type: string | 'LineCurve3';
 
     /**
-     * @default new THREE.Vector3()
+     * The start point.
+     * @defaultValue `new THREE.Vector3()`.
      */
     v1: Vector3;
 
     /**
-     * @default new THREE.Vector3()
+     * The end point.
+     * @defaultValue `new THREE.Vector3()`.
      */
     v2: Vector3;
 }

three/src/extras/curves/QuadraticBezierCurve.d.ts

@@ -1,26 +1,64 @@
 import { Vector2 } from './../../math/Vector2';
 import { Curve } from './../core/Curve';
 
+/**
+ * Create a smooth **2D** {@link http://en.wikipedia.org/wiki/B%C3%A9zier_curve#mediaviewer/File:B%C3%A9zier_2_big.gif | quadratic bezier curve},
+ * defined by a start point, end point and a single control point.
+ * @example
+ * ```typescript
+ * const curve = new THREE.QuadraticBezierCurve(
+ * new THREE.Vector2(-10, 0),
+ * new THREE.Vector2(20, 15),
+ * new THREE.Vector2(10, 0));
+ * const points = curve.getPoints(50);
+ * const geometry = new THREE.BufferGeometry().setFromPoints(points);
+ * const material = new THREE.LineBasicMaterial({
+ *     color: 0xff0000
+ * });
+ * // Create the final object to add to the scene
+ * const curveObject = new THREE.Line(geometry, material);
+ * ```
+ * @see {@link https://threejs.org/docs/index.html#api/en/extras/curves/QuadraticBezierCurve | Official Documentation}
+ * @see {@link https://github.com/mrdoob/three.js/blob/master/src/extras/curves/QuadraticBezierCurve.js | Source}
+ */
 export class QuadraticBezierCurve extends Curve<Vector2> {
-    constructor(v0: Vector2, v1: Vector2, v2: Vector2);
+    /**
+     * This constructor creates a new {@link QuadraticBezierCurve}.
+     * @param v0 The start point. Default is `new THREE.Vector2()`.
+     * @param v1 The control point. Default is `new THREE.Vector2()`.
+     * @param v2 The end point. Default is `new THREE.Vector2()`.
+     */
+    constructor(v0?: Vector2, v1?: Vector2, v2?: Vector2);
+
+    /**
+     * Read-only flag to check if a given object is of type {@link LineCurve3}.
+     * @remarks This is a _constant_ value
+     * @defaultValue `true`
+     */
+    readonly isQuadraticBezierCurve = true;
 
     /**
-     * @default 'QuadraticBezierCurve'
+     * A Read-only _string_ to check if `this` object type.
+     * @remarks Sub-classes will update this value.
+     * @defaultValue `QuadraticBezierCurve`
      */
-    type: string;
+    override readonly type: string | 'QuadraticBezierCurve';
 
     /**
-     * @default new THREE.Vector2()
+     * The start point.
+     * @defaultValue `new THREE.Vector2()`
      */
     v0: Vector2;
 
     /**
-     * @default new THREE.Vector2()
+     * The control point.
+     * @defaultValue `new THREE.Vector2()`
      */
     v1: Vector2;
 
     /**
-     * @default new THREE.Vector2()
+     * The end point.
+     * @defaultValue `new THREE.Vector2()`
      */
     v2: Vector2;
 }

three/src/extras/curves/QuadraticBezierCurve3.d.ts

@@ -1,26 +1,64 @@
 import { Vector3 } from './../../math/Vector3';
 import { Curve } from './../core/Curve';
 
+/**
+ * Create a smooth **3D** {@link http://en.wikipedia.org/wiki/B%C3%A9zier_curve#mediaviewer/File:B%C3%A9zier_2_big.gif | quadratic bezier curve},
+ * defined by a start point, end point and a single control point.
+ * @example
+ * ```typescript
+ * const curve = new THREE.QuadraticBezierCurve3(
+ * new THREE.Vector3(-10, 0, 0),
+ * new THREE.Vector3(20, 15, 0),
+ * new THREE.Vector3(10, 0, 0));
+ * const points = curve.getPoints(50);
+ * const geometry = new THREE.BufferGeometry().setFromPoints(points);
+ * const material = new THREE.LineBasicMaterial({
+ *     color: 0xff0000
+ * });
+ * // Create the final object to add to the scene
+ * const curveObject = new THREE.Line(geometry, material);
+ * ```
+ * @see {@link https://threejs.org/docs/index.html#api/en/extras/curves/QuadraticBezierCurve3 | Official Documentation}
+ * @see {@link https://github.com/mrdoob/three.js/blob/master/src/extras/curves/QuadraticBezierCurve3.js | Source}
+ */
 export class QuadraticBezierCurve3 extends Curve<Vector3> {
-    constructor(v0: Vector3, v1: Vector3, v2: Vector3);
+    /**
+     * This constructor creates a new {@link QuadraticBezierCurve}.
+     * @param v0 The start point. Default is `new THREE.Vector3()`.
+     * @param v1 The control point. Default is `new THREE.Vector3()`.
+     * @param v2 The end point. Default is `new THREE.Vector3()`.
+     */
+    constructor(v0?: Vector3, v1?: Vector3, v2?: Vector3);
+
+    /**
+     * Read-only flag to check if a given object is of type {@link QuadraticBezierCurve3}.
+     * @remarks This is a _constant_ value
+     * @defaultValue `true`
+     */
+    readonly isQuadraticBezierCurve3 = true;
 
     /**
-     * @default 'QuadraticBezierCurve3'
+     * A Read-only _string_ to check if `this` object type.
+     * @remarks Sub-classes will update this value.
+     * @defaultValue `QuadraticBezierCurve3`
      */
-    type: string;
+    override readonly type: string | 'QuadraticBezierCurve3';
 
     /**
-     * @default new THREE.Vector3()
+     * The start point.
+     * @defaultValue `new THREE.Vector3()`
      */
     v0: Vector3;
 
     /**
-     * @default new THREE.Vector3()
+     * The control point.
+     * @defaultValue `new THREE.Vector3()`
      */
     v1: Vector3;
 
     /**
-     * @default new THREE.Vector3()
+     * The end point.
+     * @defaultValue `new THREE.Vector3()`
      */
     v2: Vector3;
 }

three/src/extras/curves/SplineCurve.d.ts

@@ -1,16 +1,52 @@
 import { Vector2 } from './../../math/Vector2';
 import { Curve } from './../core/Curve';
 
+/**
+ * Create a smooth **2D** spline curve from a series of points.
+ * @example
+ * ```typescript
+ * // Create a sine-like wave
+ * const curve = new THREE.SplineCurve([
+ * new THREE.Vector2(-10, 0),
+ * new THREE.Vector2(-5, 5),
+ * new THREE.Vector2(0, 0),
+ * new THREE.Vector2(5, -5),
+ * new THREE.Vector2(10, 0)]);
+ * const points = curve.getPoints(50);
+ * const geometry = new THREE.BufferGeometry().setFromPoints(points);
+ * const material = new THREE.LineBasicMaterial({
+ *     color: 0xff0000
+ * });
+ * // Create the final object to add to the scene
+ * const splineObject = new THREE.Line(geometry, material);
+ * ```
+ * @see {@link https://threejs.org/docs/index.html#api/en/extras/curves/SplineCurve | Official Documentation}
+ * @see {@link https://github.com/mrdoob/three.js/blob/master/src/extras/curves/SplineCurve.js | Source}
+ */
 export class SplineCurve extends Curve<Vector2> {
+    /**
+     * This constructor creates a new {@link SplineCurve}.
+     * @param points An array of {@link THREE.Vector2 | Vector2} points that define the curve. Default `[]`
+     */
     constructor(points?: Vector2[]);
 
     /**
-     * @default 'SplineCurve'
+     * Read-only flag to check if a given object is of type {@link SplineCurve}.
+     * @remarks This is a _constant_ value
+     * @defaultValue `true`
+     */
+    readonly isSplineCurve = true;
+
+    /**
+     * A Read-only _string_ to check if `this` object type.
+     * @remarks Sub-classes will update this value.
+     * @defaultValue `SplineCurve`
      */
-    type: string;
+    override readonly type: string | 'SplineCurve';
 
     /**
-     * @default []
+     * The array of {@link THREE.Vector2 | Vector2} points that define the curve.
+     * @defaultValue `[]`
      */
     points: Vector2[];
 }

three/src/helpers/ArrowHelper.d.ts

@@ -4,16 +4,32 @@ import { Mesh } from './../objects/Mesh';
 import { Object3D } from './../core/Object3D';
 import { ColorRepresentation } from '../math/Color';
 
-// Extras / Helpers /////////////////////////////////////////////////////////////////////
-
+/**
+ * An 3D arrow object for visualizing directions.
+ * @example
+ * ```typescript
+ * const dir = new THREE.Vector3(1, 2, 0);
+ * //normalize the direction vector (convert to vector of length 1)
+ * dir.normalize();
+ * const origin = new THREE.Vector3(0, 0, 0);
+ * const length = 1;
+ * const hex = 0xffff00;
+ * const {@link ArrowHelper} = new THREE.ArrowHelper(dir, origin, length, hex);
+ * scene.add(arrowHelper);
+ * ```
+ * @see Example: {@link https://threejs.org/examples/#webgl_shadowmesh | WebGL / shadowmesh}
+ * @see {@link https://threejs.org/docs/index.html#api/en/helpers/ArrowHelper | Official Documentation}
+ * @see {@link https://github.com/mrdoob/three.js/blob/master/src/helpers/ArrowHelper.js | Source}
+ */
 export class ArrowHelper extends Object3D {
     /**
-     * @param [dir] Direction from origin. Must be a unit vector.
-     * @param [origin] Point at which the arrow starts.
-     * @param [length] Length of the arrow.
-     * @param [color] Hexadecimal value to define color.
-     * @param [headLength] The length of the head of the arrow.
-     * @param [headWidth] The width of the head of the arrow.
+     * Create a new instance of {@link ArrowHelper}
+     * @param dir Direction from origin. Must be a unit vector. Default `new THREE.Vector3(0, 0, 1)`
+     * @param origin Point at which the arrow starts. Default `new THREE.Vector3(0, 0, 0)`
+     * @param length Length of the arrow. Default `1`
+     * @param hex Hexadecimal value to define color. Default `0xffff00`
+     * @param headLength The length of the head of the arrow. Default `0.2 * length`
+     * @param headWidth The width of the head of the arrow. Default `0.2 * headLength`
      */
     constructor(
         dir?: Vector3,
@@ -25,9 +41,12 @@ export class ArrowHelper extends Object3D {
     );
 
     /**
-     * @default 'ArrowHelper'
+     * A Read-only _string_ to check if `this` object type.
+     * @remarks Sub-classes will update this value.
+     * @override
+     * @defaultValue `ArrowHelper`
      */
-    type: string;
+    override readonly type: string | 'ArrowHelper';
 
     /**
      * Contains the line part of the arrowHelper.
@@ -39,24 +58,36 @@ export class ArrowHelper extends Object3D {
      */
     cone: Mesh;
 
+    /**
+     * Sets the color of the arrowHelper.
+     * @param color The desired color.
+     */
+    setColor(color: ColorRepresentation): void;
+
     /**
      * @param dir The desired direction. Must be a unit vector.
      */
     setDirection(dir: Vector3): void;
 
     /**
+     * Sets the length of the arrowhelper.
      * @param length The desired length.
-     * @param [headLength] The length of the head of the arrow.
-     * @param [headWidth] The width of the head of the arrow.
+     * @param headLength The length of the head of the arrow. Default `0.2 * length`
+     * @param headWidth The width of the head of the arrow. Default `0.2 * headLength`
      */
     setLength(length: number, headLength?: number, headWidth?: number): void;
 
     /**
-     * @param color The desired color.
+     * Copy the given object into this object
+     * @remarks Note: event listeners and user-defined callbacks ({@link onAfterRender | .onAfterRender} and {@link onBeforeRender | .onBeforeRender}) are not copied.
+     * @param source
      */
-    setColor(color: ColorRepresentation): void;
-
-    copy(source: this): this;
+    override copy(source: this): 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/AxesHelper.d.ts

@@ -1,18 +1,50 @@
 import { Color } from '../math/Color';
 import { LineSegments } from './../objects/LineSegments';
 
+/**
+ * An axis object to visualize the 3 axes in a simple way.
+ * @remarks
+ * The X axis is red
+ * The Y axis is green
+ * The Z axis is blue.
+ * @example
+ * ```typescript
+ * const {@link AxesHelper} = new THREE.AxesHelper(5);
+ * scene.add(axesHelper);
+ * ```
+ * @see Example: {@link https://threejs.org/examples/#webgl_buffergeometry_compression | WebGL / buffergeometry / compression}
+ * @see Example: {@link https://threejs.org/examples/#webgl_geometry_convex | WebGL / geometry / convex}
+ * @see Example: {@link https://threejs.org/examples/#webgl_loader_nrrd | WebGL / loader / nrrd}
+ * @see {@link https://threejs.org/docs/index.html#api/en/helpers/AxesHelper | Official Documentation}
+ * @see {@link https://github.com/mrdoob/three.js/blob/master/src/helpers/AxesHelper.js | Source}
+ */
 export class AxesHelper extends LineSegments {
     /**
-     * @param [size=1]
+     * Create a new instance of {@link AxesHelper}
+     * @param size Size of the lines representing the axes. Default `1`
      */
     constructor(size?: number);
 
     /**
-     * @default 'AxesHelper'
+     * A Read-only _string_ to check if `this` object type.
+     * @remarks Sub-classes will update this value.
+     * @override
+     * @defaultValue `AxesHelper`
      */
-    type: string;
+    override readonly type: string | 'AxesHelper';
 
+    /**
+     * Sets the axes colors to {@link Color | xAxisColor}, {@link Color | yAxisColor}, {@link Color | zAxisColor}.
+     * @param xAxisColor
+     * @param yAxisColor
+     * @param zAxisColor
+     */
     setColors(xAxisColor: Color, yAxisColor: Color, zAxisColor: Color): 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;
 }