@types/three 0.168.0 → 0.170.0

three/README.md

@@ -8,7 +8,7 @@ This package contains type definitions for three (https://threejs.org/).
 Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/three.
 
 ### Additional Details
- * Last updated: Fri, 30 Aug 2024 17:36:33 GMT
+ * Last updated: Tue, 12 Nov 2024 10:02:27 GMT
  * Dependencies: [@tweenjs/tween.js](https://npmjs.com/package/@tweenjs/tween.js), [@types/stats.js](https://npmjs.com/package/@types/stats.js), [@types/webxr](https://npmjs.com/package/@types/webxr), [@webgpu/types](https://npmjs.com/package/@webgpu/types), [fflate](https://npmjs.com/package/fflate), [meshoptimizer](https://npmjs.com/package/meshoptimizer)
 
 # Credits

three/build/three.webgpu.nodes.d.ts

@@ -0,0 +1 @@
+export * from "../src/Three.WebGPU.Nodes.js";

three/build/three.webgpu.nodes.min.d.ts

@@ -0,0 +1 @@
+export * from "../src/Three.WebGPU.Nodes.js";

three/examples/jsm/Addons.d.ts

@@ -3,8 +3,6 @@ export * from "./animation/CCDIKSolver.js";
 export * from "./animation/MMDAnimationHelper.js";
 export * from "./animation/MMDPhysics.js";
 
-export * from "./cameras/CinematicCamera.js";
-
 export { default as WebGL } from "./capabilities/WebGL.js";
 
 export * from "./controls/ArcballControls.js";
@@ -121,7 +119,6 @@ export * from "./loaders/SVGLoader.js";
 export * from "./loaders/TDSLoader.js";
 export * from "./loaders/TGALoader.js";
 export * from "./loaders/TIFFLoader.js";
-export * from "./loaders/TiltLoader.js";
 export * from "./loaders/TTFLoader.js";
 export * from "./loaders/UltraHDRLoader.js";
 export * from "./loaders/USDZLoader.js";
@@ -130,7 +127,9 @@ export * from "./loaders/VRMLLoader.js";
 export * from "./loaders/VTKLoader.js";
 export * from "./loaders/XYZLoader.js";
 
+export * from "./materials/LDrawConditionalLineMaterial.js";
 export * from "./materials/MeshGouraudMaterial.js";
+export * from "./materials/MeshPostProcessingMaterial.js";
 
 export * from "./math/Capsule.js";
 export * from "./math/ColorConverter.js";
@@ -169,13 +168,9 @@ export * from "./objects/ReflectorForSSRPass.js";
 export * from "./objects/Refractor.js";
 export * from "./objects/ShadowMesh.js";
 export * from "./objects/Sky.js";
-export * from "./objects/SkyMesh.js";
 export * from "./objects/Water.js";
 export { Water as Water2 } from "./objects/Water2.js";
 export type { WaterOptions as Water2Options } from "./objects/Water2.js";
-export { WaterMesh as Water2Mesh } from "./objects/Water2Mesh.js";
-export type { WaterMeshOptions as Water2MeshOptions } from "./objects/Water2Mesh.js";
-export * from "./objects/WaterMesh.js";
 
 export * from "./physics/AmmoPhysics.js";
 export * from "./physics/RapierPhysics.js";
@@ -274,15 +269,13 @@ export * as BufferGeometryUtils from "./utils/BufferGeometryUtils.js";
 export * as CameraUtils from "./utils/CameraUtils.js";
 export * as GeometryCompressionUtils from "./utils/GeometryCompressionUtils.js";
 export * as GeometryUtils from "./utils/GeometryUtils.js";
-export * from "./utils/GPUStatsPanel.js";
 export * from "./utils/LDrawUtils.js";
-export * from "./utils/PackedPhongMaterial.js";
 export * as SceneUtils from "./utils/SceneUtils.js";
 export * from "./utils/ShadowMapViewer.js";
 export * as SkeletonUtils from "./utils/SkeletonUtils.js";
 export * as SortUtils from "./utils/SortUtils.js";
-export * from "./utils/TextureUtils.js";
 export * from "./utils/UVsDebug.js";
+export * from "./utils/WebGLTextureUtils.js";
 export * from "./utils/WorkerPool.js";
 
 export * from "./webxr/ARButton.js";

three/examples/jsm/animation/MMDAnimationHelper.d.ts

@@ -35,6 +35,10 @@ export interface MMDAnimationHelperMixer {
     duration?: number | undefined;
 }
 
+/**
+ * @deprecated The module has been deprecated and will be removed with r172. Please migrate to
+ * https://github.com/takahirox/three-mmd-loader instead.
+ */
 export class MMDAnimationHelper {
     constructor(params?: MMDAnimationHelperParameter);
     meshes: SkinnedMesh[];

three/examples/jsm/animation/MMDPhysics.d.ts

@@ -6,6 +6,10 @@ export interface MMDPhysicsParameter {
     gravity?: Vector3 | undefined;
 }
 
+/**
+ * @deprecated The module has been deprecated and will be removed with r172. Please migrate to
+ * https://github.com/takahirox/three-mmd-loader instead.
+ */
 export class MMDPhysics {
     constructor(
         mesh: SkinnedMesh,

three/examples/jsm/controls/ArcballControls.d.ts

@@ -44,7 +44,7 @@ declare class ArcballControls extends Controls<ArcballControlsEventMap> {
     focusAnimationTime: number;
 
     /**
-     * If true, camera's near and far values will be adjusted every time zoom is performed trying to mantain the same
+     * If true, camera's near and far values will be adjusted every time zoom is performed trying to maintain the same
      * visible portion given by initial near and far values ( {@link PerspectiveCamera} only ). Default is false.
      */
     adjustNearFar: boolean;

three/examples/jsm/controls/DragControls.d.ts

@@ -77,21 +77,6 @@ declare class DragControls extends Controls<DragControlsEventMap> {
      */
     constructor(objects: Object3D[], camera: Camera, domElement?: HTMLElement | null);
 
-    /**
-     * Adds the event listeners of the controls.
-     */
-    connect(): void;
-
-    /**
-     * Removes the event listeners of the controls.
-     */
-    disconnect(): void;
-
-    /**
-     * Should be called if the controls is no longer required.
-     */
-    dispose(): void;
-
     /**
      * Returns the internal {@link Raycaster} instance that is used for intersection tests.
      * @deprecated getRaycaster() has been deprecated. Use controls.raycaster instead.

three/examples/jsm/controls/TransformControls.d.ts

@@ -1,12 +1,29 @@
-import { Camera, Mesh, MOUSE, Object3D, Object3DEventMap, Quaternion, Raycaster, Vector3 } from "three";
+import { Camera, Controls, Mesh, Object3D, Quaternion, Raycaster, Vector3 } from "three";
 
 type TransformControlsMode = "translate" | "rotate" | "scale";
 
-export interface TransformControlsEventMap extends Object3DEventMap {
+export interface TransformControlsEventMap {
+    /**
+     * Fires if any type of change (object or property change) is performed. Property changes are separate events you
+     * can add event listeners to. The event type is "propertyname-changed".
+     */
     change: {};
+
+    /**
+     * Fires if a pointer (mouse/touch) becomes active.
+     */
     mouseDown: { mode: TransformControlsMode };
+
+    /**
+     * Fires if a pointer (mouse/touch) is no longer active.
+     */
     mouseUp: { mode: TransformControlsMode };
+
+    /**
+     * Fires if the controlled 3D object is changed.
+     */
     objectChange: {};
+
     "camera-changed": { value: unknown };
     "object-changed": { value: unknown };
     "enabled-changed": { value: unknown };
@@ -21,6 +38,12 @@ export interface TransformControlsEventMap extends Object3DEventMap {
     "showX-changed": { value: unknown };
     "showY-changed": { value: unknown };
     "showZ-changed": { value: unknown };
+    "minX-changed": { value: unknown };
+    "maxX-changed": { value: unknown };
+    "minY-changed": { value: unknown };
+    "maxY-changed": { value: unknown };
+    "minZ-changed": { value: unknown };
+    "maxZ-changed": { value: unknown };
     "worldPosition-changed": { value: unknown };
     "worldPositionStart-changed": { value: unknown };
     "worldQuaternion-changed": { value: unknown };
@@ -34,55 +57,202 @@ export interface TransformControlsEventMap extends Object3DEventMap {
     "eye-changed": { value: unknown };
 }
 
-export class TransformControls extends Object3D<TransformControlsEventMap> {
-    constructor(object: Camera, domElement?: HTMLElement);
-
-    domElement: HTMLElement;
-
-    // API
-
+/**
+ * This class can be used to transform objects in 3D space by adapting a similar interaction model of DCC tools like
+ * Blender. Unlike other controls, it is not intended to transform the scene's camera.
+ *
+ * TransformControls expects that its attached 3D object is part of the scene graph.
+ */
+declare class TransformControls extends Controls<TransformControlsEventMap> {
+    /**
+     * The camera of the rendered scene.
+     */
     camera: Camera;
-    object: Object3D | undefined;
-    enabled: boolean;
+
+    /**
+     * The current transformation axis.
+     */
     axis: "X" | "Y" | "Z" | "E" | "XY" | "YZ" | "XZ" | "XYZ" | "XYZE" | null;
+
+    /**
+     * The current transformation mode. Possible values are "translate", "rotate" and "scale". Default is `translate`.
+     */
     mode: TransformControlsMode;
+
+    /**
+     * By default, 3D objects are continuously translated. If you set this property to a numeric value (world units),
+     * you can define in which steps the 3D object should be translated. Default is `null`.
+     */
     translationSnap: number | null;
+
+    /**
+     * By default, 3D objects are continuously rotated. If you set this property to a numeric value (radians), you can
+     * define in which steps the 3D object should be rotated. Default is `null`.
+     */
     rotationSnap: number | null;
+
+    /**
+     * By default, 3D objects are continuously scaled. If you set this property to a numeric value, you can define in
+     * which steps the 3D object should be scaled. Default is `null`.
+     */
+    scaleSnap: number | null;
+
+    /**
+     * Defines in which coordinate space transformations should be performed. Possible values are "world" and "local".
+     * Default is `world`.
+     */
     space: "world" | "local";
+
+    /**
+     * The size of the helper UI (axes/planes). Default is *1*.
+     */
     size: number;
+
+    /**
+     * Whether or not dragging is currently performed. Read-only property.
+     */
     dragging: boolean;
+
+    /**
+     * Whether or not the x-axis helper should be visible. Default is `true`.
+     */
     showX: boolean;
+
+    /**
+     * Whether or not the y-axis helper should be visible. Default is `true`.
+     */
     showY: boolean;
+
+    /**
+     * Whether or not the z-axis helper should be visible. Default is `true`.
+     */
     showZ: boolean;
 
-    readonly isTransformControls: true;
-    mouseButtons: {
-        LEFT?: MOUSE | null | undefined;
-        MIDDLE?: MOUSE | null | undefined;
-        RIGHT?: MOUSE | null | undefined;
-    };
+    /**
+     * The minimum allowed X position during translation. Default is `-Infinity`.
+     */
+    minx: number;
+
+    /**
+     * The maximum allowed X position during translation. Default is `Infinity`.
+     */
+    maxX: number;
+
+    /**
+     * The minimum allowed Y position during translation. Default is `-Infinity`.
+     */
+    minY: number;
+
+    /**
+     * The maximum allowed Y position during translation. Default is `Infinity`.
+     */
+    maxY: number;
+
+    /**
+     * The minimum allowed Z position during translation. Default is `-Infinity`.
+     */
+    minZ: number;
+
+    /**
+     * The maximum allowed Z position during translation. Default is `Infinity`.
+     */
+    maxZ: number;
+
+    /**
+     * Creates a new instance of TransformControls.
+     * @param camera The camera of the rendered scene.
+     * @param domElement The HTML element used for event listeners. (optional)
+     */
+    constructor(camera: Camera, domElement?: HTMLElement);
+
+    /**
+     * Returns the visual representation of the controls. Add the helper to your scene to visually transform the
+     * attached 3D object.
+     */
+    getHelper(): TransformControlsRoot;
 
     pointerHover(pointer: PointerEvent | null): void;
     pointerDown(pointer: PointerEvent | null): void;
     pointerMove(pointer: PointerEvent | null): void;
     pointerUp(pointer: PointerEvent | null): void;
 
+    /**
+     * Sets the 3D object that should be transformed and ensures the controls UI is visible.
+     * @param object The 3D object that should be transformed.
+     */
     attach(object: Object3D): this;
+
+    /**
+     * Removes the current 3D object from the controls and makes the helper UI invisible.
+     */
     detach(): this;
-    getMode(): TransformControlsMode;
+
+    /**
+     * Resets the object's position, rotation and scale to when the current transform began.
+     */
+    reset(): void;
+
+    /**
+     * Returns the {@link Raycaster} object that is used for user interaction. This object is shared between all
+     * instances of TransformControls. If you set the [.layers]{@link Object3D.layers} property of the
+     * TransformControls, you will also want to set the [.layers]{@link Raycaster.layers} property on the
+     * {@link Raycaster} with a matching value, or else the TransformControls won't work as expected.
+     */
     getRaycaster(): Raycaster;
+
+    /**
+     * Returns the transformation mode.
+     */
+    getMode(): TransformControlsMode;
+
+    /**
+     * Sets the transformation mode.
+     * @param mode The transformation mode.
+     */
     setMode(mode: TransformControlsMode): void;
+
+    /**
+     * Sets the translation snap.
+     * @param translationSnap The translation snap.
+     */
     setTranslationSnap(translationSnap: number | null): void;
+
+    /**
+     * Sets the rotation snap.
+     * @param rotationSnap The rotation snap.
+     */
     setRotationSnap(rotationSnap: number | null): void;
+
+    /**
+     * Sets the scale snap.
+     * @param scaleSnap The scale snap.
+     */
     setScaleSnap(scaleSnap: number | null): void;
+
+    /**
+     * Sets the size of the helper UI.
+     * @param size The size of the helper UI.
+     */
     setSize(size: number): void;
+
+    /**
+     * Sets the coordinate space in which transformations are applied.
+     * @param space The coordinate space in which transformations are applied.
+     */
     setSpace(space: "world" | "local"): void;
-    reset(): void;
+}
+
+declare class TransformControlsRoot extends Object3D {
+    readonly isTransformControlsRoot: true;
+
+    controls: TransformControls;
+
+    constructor(controls: TransformControls);
+
     dispose(): void;
 }
 
-export class TransformControlsGizmo extends Object3D {
-    type: "TransformControlsGizmo";
+declare class TransformControlsGizmo extends Object3D {
     isTransformControlsGizmo: true;
 
     gizmo: {
@@ -104,9 +274,8 @@ export class TransformControlsGizmo extends Object3D {
     constructor();
 }
 
-export class TransformControlsPlane extends Mesh {
-    type: "TransformControlsPlane";
-    isTransformControlsPlane: true;
+declare class TransformControlsPlane extends Mesh {
+    readonly isTransformControlsPlane: true;
 
     constructor();
 
@@ -120,3 +289,5 @@ export class TransformControlsPlane extends Mesh {
     worldPosition: Vector3;
     worldQuaternion: Quaternion;
 }
+
+export { TransformControls, TransformControlsGizmo, TransformControlsPlane };

three/examples/jsm/csm/CSMFrustum.d.ts

@@ -6,14 +6,20 @@ export interface CSMFrustumVerticies {
 }
 
 export interface CSMFrustumParameters {
+    webGL?: boolean;
     projectionMatrix?: Matrix4;
     maxFar?: number;
 }
 
-export class CSMFrustum {
-    constructor(data?: CSMFrustumParameters);
+declare class CSMFrustum {
+    zNear: number;
     vertices: CSMFrustumVerticies;
+
+    constructor(data?: CSMFrustumParameters);
+
     setFromProjectionMatrix(projectionMatrix: Matrix4, maxFar: number): CSMFrustumVerticies;
     split(breaks: number[], target: CSMFrustum[]): void;
     toSpace(cameraMatrix: Matrix4, target: CSMFrustum): void;
 }
+
+export { CSMFrustum };

three/examples/jsm/csm/CSMHelper.d.ts

@@ -10,8 +10,9 @@ import {
 } from "three";
 
 import { CSM } from "./CSM.js";
+import { CSMShadowNode } from "./CSMShadowNode.js";
 
-export class CSMHelper<TCSM extends CSM = CSM> extends Group {
+export class CSMHelper<TCSM extends CSM | CSMShadowNode = CSM | CSMShadowNode> extends Group {
     constructor(csm: TCSM);
     csm: TCSM;
     displayFrustum: boolean;

three/examples/jsm/csm/CSMShadowNode.d.ts

@@ -0,0 +1,46 @@
+import { Camera, DirectionalLightShadow, Light, Object3D } from "three";
+import { Node } from "three/tsl";
+import { CSMFrustum } from "./CSMFrustum.js";
+
+export type CSMShadowNodeMode = "uniform" | "logarithmic" | "practical" | "custom";
+
+export interface CSMShadowNodeData {
+    cascades?: number | undefined;
+    maxFar?: number | undefined;
+    mode?: CSMShadowNodeMode | undefined;
+    lightMargin?: number | undefined;
+    customSplitsCallback?:
+        | ((cascades: number, cameraNear: number, cameraFar: number, breaks: number[]) => void)
+        | undefined;
+}
+
+declare class LwLight extends Object3D {
+    target: Object3D;
+    shadow?: DirectionalLightShadow;
+
+    constructor();
+}
+
+declare class CSMShadowNode extends Node {
+    light: Light;
+    camera: Camera | null;
+    cascades: number;
+    maxFar: number;
+    mode: CSMShadowNodeMode;
+    lightMargin: number;
+    customSplitsCallback: (cascades: number, cameraNear: number, cameraFar: number, breaks: number[]) => void;
+
+    fade: boolean;
+
+    breaks: number[];
+    mainFrustum: CSMFrustum | null;
+    frustums: CSMFrustum[];
+
+    lights: LwLight[];
+
+    constructor(light: Light, data?: CSMShadowNodeData);
+
+    updateFrustums(): void;
+}
+
+export { CSMShadowNode };

three/examples/jsm/curves/NURBSCurve.d.ts

@@ -1,4 +1,12 @@
-import { Curve, Vector2, Vector3, Vector4 } from "three";
+import { Curve, CurveJSON, Vector2, Vector3, Vector4 } from "three";
+
+export interface NURBSCurveJSON extends CurveJSON {
+    degree: number;
+    knots: number[];
+    controlPoints: number[][];
+    startKnot: number;
+    endKnot: number;
+}
 
 export class NURBSCurve extends Curve<Vector3> {
     degree: number;
@@ -14,4 +22,7 @@ export class NURBSCurve extends Curve<Vector3> {
         startKnot?: number,
         endKnot?: number,
     );
+
+    toJSON(): NURBSCurveJSON;
+    fromJSON(json: NURBSCurveJSON): this;
 }

three/examples/jsm/exporters/EXRExporter.d.ts

@@ -6,6 +6,7 @@
  */
 
 import { DataTexture, TextureDataType, WebGLRenderer, WebGLRenderTarget } from "three";
+import { WebGPURenderer } from "three/webgpu";
 
 export const NO_COMPRESSION: 0;
 export const ZIPS_COMPRESSION: 2;
@@ -17,6 +18,10 @@ export interface EXRExporterParseOptions {
 }
 
 export class EXRExporter {
-    parse(renderer: WebGLRenderer, renderTarget: WebGLRenderTarget, options?: EXRExporterParseOptions): Uint8Array;
-    parse(dataTexture: DataTexture, options?: EXRExporterParseOptions): Uint8Array;
+    parse(
+        renderer: WebGLRenderer | WebGPURenderer,
+        renderTarget: WebGLRenderTarget,
+        options?: EXRExporterParseOptions,
+    ): Promise<Uint8Array>;
+    parse(dataTexture: DataTexture, options?: EXRExporterParseOptions): Promise<Uint8Array>;
 }

three/examples/jsm/exporters/GLTFExporter.d.ts

@@ -47,12 +47,22 @@ export interface GLTFExporterOptions {
     includeCustomExtensions?: boolean;
 }
 
-export class GLTFExporter {
+type TextureUtils = {
+    decompress:
+        | ((texture: Texture, maxTextureSize?: number) => Promise<void>)
+        | ((texture: Texture, maxTextureSize?: number) => void);
+};
+
+declare class GLTFExporter {
+    textureUtils: TextureUtils | null;
+
     constructor();
 
     register(callback: (writer: GLTFWriter) => GLTFExporterPlugin): this;
     unregister(callback: (writer: GLTFWriter) => GLTFExporterPlugin): this;
 
+    setTextureUtils(utils: TextureUtils | null): this;
+
     /**
      * Generates a .gltf (JSON) or .glb (binary) output from the input (Scenes or Objects)
      *
@@ -94,11 +104,15 @@ export class GLTFExporter {
     ): Promise<ArrayBuffer | { [key: string]: any }>;
 }
 
-export class GLTFWriter {
+declare class GLTFWriter {
+    textureUtils: TextureUtils | null;
+
     constructor();
 
     setPlugins(plugins: GLTFExporterPlugin[]): void;
 
+    setTextureUtils(utils: TextureUtils | null): this;
+
     /**
      * Parse scenes and generate GLTF output
      *
@@ -106,7 +120,7 @@ export class GLTFWriter {
      * @param onDone Callback on completed
      * @param options options
      */
-    write(
+    writeAsync(
         input: Object3D | Object3D[],
         onDone: (gltf: ArrayBuffer | { [key: string]: any }) => void,
         options?: GLTFExporterOptions,
@@ -121,3 +135,6 @@ export interface GLTFExporterPlugin {
     beforeParse?: (input: Object3D | Object3D[]) => void;
     afterParse?: (input: Object3D | Object3D[]) => void;
 }
+
+export { GLTFExporter };
+export type { GLTFWriter };

three/examples/jsm/exporters/KTX2Exporter.d.ts

@@ -1,5 +1,7 @@
 import { Data3DTexture, DataTexture, WebGLRenderer, WebGLRenderTarget } from "three";
+import { WebGPURenderer } from "three/webgpu";
 
 export class KTX2Exporter {
-    parse(arg1: Data3DTexture | DataTexture | WebGLRenderer, arg2?: WebGLRenderTarget): Uint8Array;
+    parse(renderer: WebGLRenderer | WebGPURenderer, rtt?: WebGLRenderTarget): Promise<Uint8Array>;
+    parse(texture: Data3DTexture | DataTexture): Promise<Uint8Array>;
 }

three/examples/jsm/exporters/MMDExporter.d.ts

@@ -1,5 +1,9 @@
 import { Object3D } from "three";
 
+/**
+ * @deprecated The module has been deprecated and will be removed with r172. Please migrate to
+ * https://github.com/takahirox/three-mmd-loader instead.
+ */
 export class MMDExporter {
     constructor();
 

three/examples/jsm/exporters/USDZExporter.d.ts

@@ -1,4 +1,6 @@
 import { Object3D } from "three";
+import * as WebGLTextureUtils from "../utils/WebGLTextureUtils.js";
+import * as WebGPUTextureUtils from "../utils/WebGPUTextureUtils.js";
 
 export interface USDZExporterOptions {
     ar?: { anchoring: { type: "plane" }; planeAnchoring: { alignment: "horizontal" | "vertical" | "any" } } | undefined;
@@ -8,6 +10,8 @@ export interface USDZExporterOptions {
 }
 
 export class USDZExporter {
+    textureUtils: typeof WebGLTextureUtils | typeof WebGPUTextureUtils | null;
+
     constructor();
 
     parse(

three/examples/jsm/geometries/DecalGeometry.d.ts

@@ -1,10 +1,16 @@
 import { BufferGeometry, Euler, Mesh, Vector3 } from "three";
 
-export class DecalGeometry extends BufferGeometry {
+declare class DecalGeometry extends BufferGeometry {
     constructor(mesh: Mesh, position: Vector3, orientation: Euler, size: Vector3);
 }
 
-export class DecalVertex {
-    constructor(position: Vector3, normal: Vector3);
+declare class DecalVertex {
+    position: Vector3;
+    normal: Vector3 | null;
+
+    constructor(position: Vector3, normal?: Vector3 | null);
+
     clone(): this;
 }
+
+export { DecalGeometry, DecalVertex };

three/examples/jsm/geometries/TeapotGeometry.d.ts

@@ -1,9 +1,9 @@
 import { BufferGeometry } from "three";
 
 /**
- * {@link TeapotGeometry} tesselates the famous Utah teapot database by Martin Newell.
+ * TeapotGeometry tessellates the famous Utah teapot database by Martin Newell.
  *
- * {@link TeapotGeometry} is an add-on, and must be imported explicitly. See
+ * TeapotGeometry is an add-on, and must be imported explicitly. See
  * [Installation / Addons]{@link https://threejs.org/docs/#manual/en/introduction/Installation}.
  *
  * @example