@types/three 0.150.0 → 0.150.1

three/src/core/Object3D.d.ts

@@ -28,7 +28,14 @@ export class Object3D<E extends BaseEvent = Event> extends EventDispatcher<E> {
     constructor();
 
     /**
-     * Unique number for this object instance.
+     * Flag to check if a given object is of type {@link Object3D}.
+     * @remarks This is a _constant_ value
+     * @defaultValue `true`
+     */
+    readonly isObject3D: true;
+
+    /**
+     * Unique number for this {@link Object3D} instance.
      * @remarks Note that ids are assigned in chronological order: 1, 2, 3, ..., incrementing by one for each new object.
      * @remarks Expects a `Integer`
      */
@@ -41,15 +48,19 @@ export class Object3D<E extends BaseEvent = Event> extends EventDispatcher<E> {
     uuid: string;
 
     /**
-     * Optional name of the object (doesn't need to be unique).
-     * @defaultValue `''`
+     * Optional name of the object
+     * @remarks _(doesn't need to be unique)_.
+     * @defaultValue `""`
      */
     name: string;
 
     /**
+     * A Read-only _string_ to check `this` object type.
+     * @remarks This can be used to find a specific type of Object3D in a scene.
+     * @remarks Sub-classes will update this value.
      * @defaultValue `Object3D`
      */
-    type: string; // TODO Replace for "Object3D" // TODO add readonly
+    readonly type: string | 'Object3D';
 
     /**
      * Object's parent in the {@link https://en.wikipedia.org/wiki/Scene_graph | scene graph}.
@@ -209,13 +220,6 @@ export class Object3D<E extends BaseEvent = Event> extends EventDispatcher<E> {
      */
     customDistanceMaterial?: Material | undefined;
 
-    /**
-     * Flag to check if a given object is of type {@link Object3D}.
-     * @remarks This is a _constant_ value
-     * @defaultValue `true`
-     */
-    readonly isObject3D: true;
-
     /**
      * An optional callback that is executed immediately before a 3D object is rendered.
      * @remarks This function is called with the following parameters: renderer, scene, camera, geometry, material, group.
@@ -551,7 +555,7 @@ export class Object3D<E extends BaseEvent = Event> extends EventDispatcher<E> {
     toJSON(meta?: { geometries: any; materials: any; textures: any; images: any }): any;
 
     /**
-     * Returns a clone of this object and optionally all descendants.
+     * Returns a clone of `this` object and optionally all descendants.
      * @param recursive If true, descendants of the object are also cloned. Default `true`
      */
     clone(recursive?: boolean): this;
@@ -562,5 +566,5 @@ export class Object3D<E extends BaseEvent = Event> extends EventDispatcher<E> {
      * @param source
      * @param recursive If true, descendants of the object are also copied. Default `true`
      */
-    copy(source: Object3D, recursive?: boolean): this;
+    copy(source: this, recursive?: boolean): this;
 }

three/src/core/Raycaster.d.ts

@@ -35,6 +35,7 @@ export interface Intersection<TIntersected extends Object3D = Object3D> {
 export interface RaycasterParameters {
     Mesh?: any;
     Line?: { threshold: number } | undefined;
+    Line2?: { threshold: number } | undefined;
     LOD?: any;
     Points?: { threshold: number } | undefined;
     Sprite?: any;

three/src/geometries/BoxGeometry.d.ts

@@ -1,13 +1,29 @@
 import { BufferGeometry } from '../core/BufferGeometry';
 
+/**
+ * {@link BoxGeometry} is a geometry class for a rectangular cuboid with a given 'width', 'height', and 'depth'
+ * @remarks On creation, the cuboid is centred on the origin, with each edge parallel to one of the axes.
+ * @example
+ * ```typescript
+ * const geometry = new THREE.BoxGeometry(1, 1, 1);
+ * const material = new THREE.MeshBasicMaterial({
+ *     color: 0x00ff00
+ * });
+ * const cube = new THREE.Mesh(geometry, material);
+ * scene.add(cube);
+ * ```
+ * @see {@link https://threejs.org/docs/index.html#api/en/geometries/BoxGeometry | Official Documentation}
+ * @see {@link https://github.com/mrdoob/three.js/blob/master/src/geometries/BoxGeometry.js | Source}
+ */
 export class BoxGeometry extends BufferGeometry {
     /**
-     * @param [width=1] — Width of the sides on the X axis.
-     * @param [height=1] — Height of the sides on the Y axis.
-     * @param [depth=1] — Depth of the sides on the Z axis.
-     * @param [widthSegments=1] — Number of segmented faces along the width of the sides.
-     * @param [heightSegments=1] — Number of segmented faces along the height of the sides.
-     * @param [depthSegments=1] — Number of segmented faces along the depth of the sides.
+     * Create a new instance of {@link BoxGeometry}
+     * @param width Width; that is, the length of the edges parallel to the X axis. Optional; Expects a `Float`. Default `1`
+     * @param height Height; that is, the length of the edges parallel to the Y axis. Optional; Expects a `Float`. Default `1`
+     * @param depth Depth; that is, the length of the edges parallel to the Z axis. Optional; Expects a `Float`. Default `1`
+     * @param widthSegments Number of segmented rectangular faces along the width of the sides. Optional; Expects a `Integer`. Default `1`
+     * @param heightSegments Number of segmented rectangular faces along the height of the sides. Optional; Expects a `Integer`. Default `1`
+     * @param depthSegments Number of segmented rectangular faces along the depth of the sides. Optional; Expects a `Integer`. Default `1`
      */
     constructor(
         width?: number,
@@ -19,18 +35,25 @@ export class BoxGeometry extends BufferGeometry {
     );
 
     /**
-     * @default 'BoxGeometry'
+     * A Read-only _string_ to check if `this` object type.
+     * @remarks Sub-classes will update this value.
+     * @defaultValue `BoxGeometry`
      */
-    type: string;
+    override readonly type: string | 'BoxGeometry';
 
-    parameters: {
-        width: number;
-        height: number;
-        depth: number;
-        widthSegments: number;
-        heightSegments: number;
-        depthSegments: number;
+    /**
+     * An object with a property for each of the constructor parameters.
+     * @remarks Any modification after instantiation does not change the geometry.
+     */
+    readonly parameters: {
+        readonly width: number;
+        readonly height: number;
+        readonly depth: number;
+        readonly widthSegments: number;
+        readonly heightSegments: number;
+        readonly depthSegments: number;
     };
 
-    static fromJSON(data: any): BoxGeometry;
+    /** @internal */
+    static fromJSON(data: {}): BoxGeometry;
 }

three/src/geometries/CapsuleGeometry.d.ts

@@ -1,25 +1,48 @@
 import { BufferGeometry } from '../core/BufferGeometry';
 
+/**
+ * {@link CapsuleGeometry} is a geometry class for a capsule with given radii and height
+ * @remarks It is constructed using a lathe.
+ * @example
+ * ```typescript
+ * const geometry = new THREE.CapsuleGeometry(1, 1, 4, 8);
+ * const material = new THREE.MeshBasicMaterial({
+ *     color: 0x00ff00
+ * });
+ * const capsule = new THREE.Mesh(geometry, material);
+ * scene.add(capsule);
+ * ```
+ * @see {@link https://threejs.org/docs/index.html#api/en/geometries/CapsuleGeometry | Official Documentation}
+ * @see {@link https://github.com/mrdoob/three.js/blob/master/src/geometries/CapsuleGeometry.js | Source}
+ */
 export class CapsuleGeometry extends BufferGeometry {
     /**
-     * @param [radius=1] — Radius of the capsule.
-     * @param [length=1] — Length of the middle section.
-     * @param [capSegments=4] — Number of curve segments used to build the caps.
-     * @param [radialSegments=8] — Number of segmented faces around the circumference of the capsule.
+     * Create a new instance of {@link CapsuleGeometry}
+     * @param radius Radius of the capsule. Expects a `Float`. Default `1`
+     * @param length Length of the middle section. Expects a `Float`. Default `1`
+     * @param capSubdivisions Number of curve segments used to build the caps. Expects a `Integer`. Default `4`
+     * @param radialSegments Number of segmented faces around the circumference of the capsule. Expects a `Integer`. Default `8`
      */
     constructor(radius?: number, length?: number, capSegments?: number, radialSegments?: number);
 
     /**
-     * @default 'CapsuleGeometry'
+     * A Read-only _string_ to check if `this` object type.
+     * @remarks Sub-classes will update this value.
+     * @defaultValue `CapsuleGeometry`
      */
-    type: string;
+    override readonly type: string | 'CapsuleGeometry';
 
-    parameters: {
-        radius: number;
-        length: number;
-        capSegments: number;
-        radialSegments: number;
+    /**
+     * An object with a property for each of the constructor parameters.
+     * @remarks Any modification after instantiation does not change the geometry.
+     */
+    readonly parameters: {
+        readonly radius: number;
+        readonly length: number;
+        readonly capSegments: number;
+        readonly radialSegments: number;
     };
 
-    static fromJSON(data: any): CapsuleGeometry;
+    /** @internal */
+    static fromJSON(data: {}): CapsuleGeometry;
 }

three/src/geometries/CircleGeometry.d.ts

@@ -1,25 +1,51 @@
 import { BufferGeometry } from '../core/BufferGeometry';
 
+/**
+ * {@link CircleGeometry} is a simple shape of Euclidean geometry
+ * @remarks
+ * It is constructed from a number of triangular segments that are oriented around a central point and extend as far out as a given radius
+ * It is built counter-clockwise from a start angle and a given central angle
+ * It can also be used to create regular polygons, where the number of segments determines the number of sides.
+ * @example
+ * ```typescript
+ * const geometry = new THREE.CircleGeometry(5, 32);
+ * const material = new THREE.MeshBasicMaterial({
+ *     color: 0xffff00
+ * });
+ * const circle = new THREE.Mesh(geometry, material);
+ * scene.add(circle);
+ * ```
+ * @see {@link https://threejs.org/docs/index.html#api/en/geometries/CircleGeometry | Official Documentation}
+ * @see {@link https://github.com/mrdoob/three.js/blob/master/src/geometries/CircleGeometry.js | Source}
+ */
 export class CircleGeometry extends BufferGeometry {
     /**
-     * @param radius - Radius of the circle, default = 1.
-     * @param segments - Number of segments (triangles), minimum = 3, default = 32.
-     * @param thetaStart - Start angle for first segment, default = 0 (three o'clock position).
-     * @param thetaLength - The central angle, often called theta, of the circular sector. The default is 2*Pi, which makes for a complete circle.
+     * Create a new instance of {@link CircleGeometry}
+     * @param radius Radius of the circle. Expects a `Float`. Default `1`
+     * @param segments Number of segments (triangles). Expects a `Integer`. Minimum `3`. Default `32`
+     * @param thetaStart Start angle for first segment. Expects a `Float`. Default `0`, _(three o'clock position)_.
+     * @param thetaLength The central angle, often called theta, of the circular sector. Expects a `Float`. Default `Math.PI * 2`, _which makes for a complete circle_.
      */
     constructor(radius?: number, segments?: number, thetaStart?: number, thetaLength?: number);
 
     /**
-     * @default 'CircleGeometry'
+     * A Read-only _string_ to check if `this` object type.
+     * @remarks Sub-classes will update this value.
+     * @defaultValue `CircleGeometry`
      */
-    type: string;
+    override readonly type: string | 'CircleGeometry';
 
-    parameters: {
-        radius: number;
-        segments: number;
-        thetaStart: number;
-        thetaLength: number;
+    /**
+     * An object with a property for each of the constructor parameters.
+     * @remarks Any modification after instantiation does not change the geometry.
+     */
+    readonly parameters: {
+        readonly radius: number;
+        readonly segments: number;
+        readonly thetaStart: number;
+        readonly thetaLength: number;
     };
 
-    static fromJSON(data: any): CircleGeometry;
+    /** @internal */
+    static fromJSON(data: {}): CircleGeometry;
 }

three/src/geometries/ConeGeometry.d.ts

@@ -1,14 +1,29 @@
 import { CylinderGeometry } from './CylinderGeometry';
 
+/**
+ * A class for generating cone geometries.
+ * @example
+ * ```typescript
+ * const geometry = new THREE.ConeGeometry(5, 20, 32);
+ * const material = new THREE.MeshBasicMaterial({
+ *     color: 0xffff00
+ * });
+ * const cone = new THREE.Mesh(geometry, material);
+ * scene.add(cone);
+ * ```
+ * @see {@link https://threejs.org/docs/index.html#api/en/geometries/ConeGeometry | Official Documentation}
+ * @see {@link https://github.com/mrdoob/three.js/blob/master/src/geometries/ConeGeometry.js | Source}
+ */
 export class ConeGeometry extends CylinderGeometry {
     /**
-     * @param radius - Radius of the cone base. Default is 1.
-     * @param height - Height of the cone. Default is 1.
-     * @param radialSegments - Number of segmented faces around the circumference of the cone. Default is 32
-     * @param heightSegments - Number of rows of faces along the height of the cone. Default is 1.
-     * @param openEnded - A Boolean indicating whether the base of the cone is open or capped. Default is false, meaning capped.
-     * @param thetaStart - Start angle for first segment, default = 0 (three o'clock position).
-     * @param thetaLength - The central angle, often called theta, of the circular sector. The default is 2*Pi, which makes for a complete cone.
+     * Create a new instance of {@link ConeGeometry}
+     * @param radius Radius of the cone base. Expects a `Float`. Default `1`
+     * @param height Height of the cone. Expects a `Float`. Default `1`
+     * @param radialSegments Number of segmented faces around the circumference of the cone. Expects a `Integer`. Default `32`
+     * @param heightSegments Number of rows of faces along the height of the cone. Expects a `Integer`. Default `1`
+     * @param openEnded A Boolean indicating whether the base of the cone is open or capped. Default `false`, _meaning capped_.
+     * @param thetaStart Start angle for first segment. Expects a `Float`. Default `0`, _(three o'clock position)_.
+     * @param thetaLength The central angle, often called theta, of the circular sector. Expects a `Float`. Default `Math.PI * 2`, _which makes for a complete cone_.
      */
     constructor(
         radius?: number,
@@ -21,9 +36,29 @@ export class ConeGeometry extends CylinderGeometry {
     );
 
     /**
-     * @default 'ConeGeometry'
+     * A Read-only _string_ to check if `this` object type.
+     * @remarks Sub-classes will update this value.
+     * @defaultValue `ConeGeometry`
      */
-    type: string;
+    override readonly type: string | 'ConeGeometry';
 
-    static fromJSON(data: any): ConeGeometry;
+    /**
+     * An object with a property for each of the constructor parameters.
+     * @remarks {@link radiusTop} and {@link radiusBottom} are from base {@link THREE.CylinderGeometry} class.
+     * @remarks Any modification after instantiation does not change the geometry.
+     */
+    override readonly parameters: {
+        readonly radius: number;
+        readonly radiusTop: number;
+        readonly radiusBottom: number;
+        readonly height: number;
+        readonly radialSegments: number;
+        readonly heightSegments: number;
+        readonly openEnded: boolean;
+        readonly thetaStart: number;
+        readonly thetaLength: number;
+    };
+
+    /** @internal */
+    static fromJSON(data: {}): ConeGeometry;
 }

three/src/geometries/CylinderGeometry.d.ts

@@ -1,15 +1,30 @@
 import { BufferGeometry } from '../core/BufferGeometry';
 
+/**
+ * A class for generating cylinder geometries.
+ * @example
+ * ```typescript
+ * const geometry = new THREE.CylinderGeometry(5, 5, 20, 32);
+ * const material = new THREE.MeshBasicMaterial({
+ *     color: 0xffff00
+ * });
+ * const cylinder = new THREE.Mesh(geometry, material);
+ * scene.add(cylinder);
+ * ```
+ * @see {@link https://threejs.org/docs/index.html#api/en/geometries/CylinderGeometry | Official Documentation}
+ * @see {@link https://github.com/mrdoob/three.js/blob/master/src/geometries/CylinderGeometry.js | Source}
+ */
 export class CylinderGeometry extends BufferGeometry {
     /**
-     * @param radiusTop - Radius of the cylinder at the top. Default is 1.
-     * @param radiusBottom - Radius of the cylinder at the bottom. Default is 1.
-     * @param height - Height of the cylinder. Default is 1.
-     * @param radialSegments - Number of segmented faces around the circumference of the cylinder. Default is 32
-     * @param heightSegments - Number of rows of faces along the height of the cylinder. Default is 1.
-     * @param openEnded - A Boolean indicating whether the ends of the cylinder are open or capped. Default is false, meaning capped.
-     * @param thetaStart - Start angle for first segment, default = 0 (three o'clock position).
-     * @param thetaLength - The central angle, often called theta, of the circular sector. The default is 2*Pi, which makes for a complete cylinder.
+     * Create a new instance of {@link CylinderGeometry}
+     * @param radiusTop Radius of the cylinder at the top. Default `1`
+     * @param radiusBottom Radius of the cylinder at the bottom. Default `1`
+     * @param height Height of the cylinder. Default `1`
+     * @param radialSegments Number of segmented faces around the circumference of the cylinder. Default `32`
+     * @param heightSegments Number of rows of faces along the height of the cylinder. Expects a `Integer`. Default `1`
+     * @param openEnded A Boolean indicating whether the ends of the cylinder are open or capped. Default `false`, _meaning capped_.
+     * @param thetaStart Start angle for first segment. Default `0`, _(three o'clock position)_.
+     * @param thetaLength The central angle, often called theta, of the circular sector. Default `Math.PI * 2`, _which makes for a complete cylinder.
      */
     constructor(
         radiusTop?: number,
@@ -23,20 +38,27 @@ export class CylinderGeometry extends BufferGeometry {
     );
 
     /**
-     * @default 'CylinderGeometry'
+     * A Read-only _string_ to check if `this` object type.
+     * @remarks Sub-classes will update this value.
+     * @defaultValue `CylinderGeometry`
      */
-    type: string;
+    override readonly type: string | 'CylinderGeometry';
 
-    parameters: {
-        radiusTop: number;
-        radiusBottom: number;
-        height: number;
-        radialSegments: number;
-        heightSegments: number;
-        openEnded: boolean;
-        thetaStart: number;
-        thetaLength: number;
+    /**
+     * An object with a property for each of the constructor parameters.
+     * @remarks Any modification after instantiation does not change the geometry.
+     */
+    readonly parameters: {
+        readonly radiusTop: number;
+        readonly radiusBottom: number;
+        readonly height: number;
+        readonly radialSegments: number;
+        readonly heightSegments: number;
+        readonly openEnded: boolean;
+        readonly thetaStart: number;
+        readonly thetaLength: number;
     };
 
+    /** @internal */
     static fromJSON(data: any): CylinderGeometry;
 }

three/src/geometries/DodecahedronGeometry.d.ts

@@ -1,16 +1,25 @@
 import { PolyhedronGeometry } from './PolyhedronGeometry';
 
+/**
+ * A class for generating a dodecahedron geometries.
+ * @see {@link https://threejs.org/docs/index.html#api/en/geometries/DodecahedronGeometry | Official Documentation}
+ * @see {@link https://github.com/mrdoob/three.js/blob/master/src/geometries/DodecahedronGeometry.js | Source}
+ */
 export class DodecahedronGeometry extends PolyhedronGeometry {
     /**
-     * @param [radius=1]
-     * @param [detail=0]
+     * Create a new instance of {@link DodecahedronGeometry}
+     * @param radius Radius of the dodecahedron. Expects a `Float`. Default `1`
+     * @param detail Setting this to a value greater than 0 adds vertices making it no longer a dodecahedron. Expects a `Integer`. Default `0`
      */
     constructor(radius?: number, detail?: number);
 
     /**
-     * @default 'DodecahedronGeometry'
+     * A Read-only _string_ to check if `this` object type.
+     * @remarks Sub-classes will update this value.
+     * @defaultValue `DodecahedronGeometry`
      */
-    type: string;
+    override readonly type: string | 'DodecahedronGeometry';
 
-    static fromJSON(data: any): DodecahedronGeometry;
+    /** @internal */
+    static fromJSON(data: {}): DodecahedronGeometry;
 }

three/src/geometries/EdgesGeometry.d.ts

@@ -1,19 +1,41 @@
 import { BufferGeometry } from '../core/BufferGeometry';
 
+/**
+ * This can be used as a helper object to view the edges of a {@link THREE.BufferGeometry | geometry}.
+ * @example
+ * ```typescript
+ * const geometry = new THREE.BoxGeometry(100, 100, 100);
+ * const edges = new THREE.EdgesGeometry(geometry);
+ * const line = new THREE.LineSegments(edges, new THREE.LineBasicMaterial({
+ *     color: 0xffffff
+ * }));
+ * scene.add(line);
+ * ```
+ * @see Example: {@link https://threejs.org/examples/#webgl_helpers | helpers}
+ * @see {@link https://threejs.org/docs/index.html#api/en/geometries/EdgesGeometry | Official Documentation}
+ * @see {@link https://github.com/mrdoob/three.js/blob/master/src/geometries/EdgesGeometry.js | Source}
+ */
 export class EdgesGeometry<TBufferGeometry extends BufferGeometry = BufferGeometry> extends BufferGeometry {
     /**
-     * @param geometry
-     * @param [thresholdAngle=1]
+     * Create a new instance of {@link EdgesGeometry}
+     * @param geometry Any geometry object. Default `null`.
+     * @param thresholdAngle An edge is only rendered if the angle (in degrees) between the face normals of the adjoining faces exceeds this value. Expects a `Integer`. Default `1` _degree_.
      */
-    constructor(geometry?: TBufferGeometry, thresholdAngle?: number);
+    constructor(geometry?: TBufferGeometry | null, thresholdAngle?: number);
 
     /**
-     * @default 'EdgesGeometry'
+     * A Read-only _string_ to check if `this` object type.
+     * @remarks Sub-classes will update this value.
+     * @defaultValue `EdgesGeometry`
      */
-    type: string;
+    override readonly type: string | 'EdgesGeometry';
 
-    parameters: {
-        geometry: TBufferGeometry;
-        thresholdAngle: number;
+    /**
+     * An object with a property for each of the constructor parameters.
+     * @remarks Any modification after instantiation does not change the geometry.
+     */
+    readonly parameters: {
+        readonly geometry: TBufferGeometry | null;
+        readonly thresholdAngle: number;
     };
 }

three/src/geometries/ExtrudeGeometry.d.ts

@@ -6,35 +6,67 @@ import { BufferGeometry } from './../core/BufferGeometry';
 
 export interface ExtrudeGeometryOptions {
     /**
-     * @default 12
+     * Number of points on the curves.
+     * Expects a `Integer`.
+     * @defaultValue `12`
      */
     curveSegments?: number | undefined;
+
     /**
-     * @default 1
+     * Number of points used for subdividing segments along the depth of the extruded spline.
+     * @defaultValue `1`
      */
     steps?: number | undefined;
+
     /**
-     * @default 100
+     * Depth to extrude the shape.
+     * @defaultValue `1`
      */
     depth?: number | undefined;
+
     /**
-     * @default true
+     * Turn on bevel. Applying beveling to the shape.
+     * @defaultValue `true`
      */
     bevelEnabled?: boolean | undefined;
+
     /**
-     * @default 6
+     * How deep into the original shape the bevel goes.
+     * Expects a `Float`.
+     * @defaultValue `0.2`
      */
     bevelThickness?: number | undefined;
+
+    /**
+     * Distance from the shape outline that the bevel extends
+     * Expects a `Float`.
+     * @defaultValue `bevelThickness - 0.1`
+     */
     bevelSize?: number | undefined;
+
     /**
-     * @default 0
+     * Distance from the shape outline that the bevel starts.
+     * Expects a `Float`.
+     * @defaultValue `0`
      */
     bevelOffset?: number | undefined;
+
     /**
-     * @default 3
+     * Number of bevel layers/segments.
+     * Expects a `Integer`.
+     * @defaultValue `3`
      */
     bevelSegments?: number | undefined;
+
+    /**
+     * A 3D spline path along which the shape should be extruded.
+     * @remarks Bevels not supported for path extrusion.
+     */
     extrudePath?: Curve<Vector3> | undefined;
+
+    /**
+     * A object that provides UV generator functions.
+     */
     UVGenerator?: UVGenerator | undefined;
 }
 
@@ -56,16 +88,65 @@ export interface UVGenerator {
     ): Vector2[];
 }
 
+/**
+ * Creates extruded geometry from a path shape.
+ * @remarks This object extrudes a 2D shape to a 3D geometry.
+ * @remarks When creating a Mesh with this geometry, if you'd like to have a separate material used for its face and its extruded sides, you can use an array of materials
+ * @remarks The first material will be applied to the face; the second material will be applied to the sides.
+ * @example
+ * ```typescript
+ * const length = 12, width = 8;
+ * const shape = new THREE.Shape();
+ * shape.moveTo(0, 0);
+ * shape.lineTo(0, width);
+ * shape.lineTo(length, width);
+ * shape.lineTo(length, 0);
+ * shape.lineTo(0, 0);
+ * const extrudeSettings = {
+ *     steps: 2,
+ *     depth: 16,
+ *     bevelEnabled: true,
+ *     bevelThickness: 1,
+ *     bevelSize: 1,
+ *     bevelOffset: 0,
+ *     bevelSegments: 1
+ * };
+ * const geometry = new THREE.ExtrudeGeometry(shape, extrudeSettings);
+ * const material = new THREE.MeshBasicMaterial({
+ *     color: 0x00ff00
+ * });
+ * const mesh = new THREE.Mesh(geometry, material);
+ * scene.add(mesh);
+ * ```
+ * @see {@link https://threejs.org/docs/index.html#api/en/geometries/ExtrudeGeometry | Official Documentation}
+ * @see {@link https://github.com/mrdoob/three.js/blob/master/src/geometries/ExtrudeGeometry.js | Source}
+ */
 export class ExtrudeGeometry extends BufferGeometry {
+    /**
+     * Create a new instance of {@link ExtrudeGeometry}
+     * @param shapes Shape or an array of shapes. Default `new Shape([new Vector2(0.5, 0.5), new Vector2(-0.5, 0.5), new Vector2(-0.5, -0.5), new Vector2(0.5, -0.5)])`.
+     * @param options Object that can contain the following parameters. @see {@link ExtrudeGeometryOptions} for defaults.
+     */
     constructor(shapes?: Shape | Shape[], options?: ExtrudeGeometryOptions);
 
     /**
-     * @default 'ExtrudeGeometry'
+     * A Read-only _string_ to check if `this` object type.
+     * @remarks Sub-classes will update this value.
+     * @defaultValue `ExtrudeGeometry`
+     */
+    override readonly type: string | 'ExtrudeGeometry';
+
+    /**
+     * An object with a property for each of the constructor parameters.
+     * @remarks Any modification after instantiation does not change the geometry.
      */
-    type: string;
+    readonly parameters: {
+        readonly shapes: Shape | Shape[];
+        readonly options: ExtrudeGeometryOptions;
+    };
 
-    addShapeList(shapes: Shape[], options?: any): void;
-    addShape(shape: Shape, options?: any): void;
+    addShape(shape: Shape): void;
 
-    static fromJSON(data: any): ExtrudeGeometry;
+    /** @internal */
+    static fromJSON(data: {}, shapes: unknown): ExtrudeGeometry;
 }