Skip to content

Commit 5b6f5eb

Browse files
s-rigaudSamuel Rigaud
andauthored
Types: fix generic types (#31773)
Co-authored-by: Samuel Rigaud <[email protected]>
1 parent 4ac4e3e commit 5b6f5eb

File tree

12 files changed

+18
-18
lines changed

12 files changed

+18
-18
lines changed

examples/jsm/math/Lut.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ class Lut {
4545
/**
4646
* The currently selected color map.
4747
*
48-
* @type {Array}
48+
* @type {Array<Array<number>>}
4949
*/
5050
this.map = [];
5151

@@ -219,7 +219,7 @@ class Lut {
219219
* Adds a color map to this Lut instance.
220220
*
221221
* @param {string} name - The name of the color map.
222-
* @param {Array} arrayOfColors - An array of color values. Each value is an array
222+
* @param {Array<Array<number>>} arrayOfColors - An array of color values. Each value is an array
223223
* holding a threshold and the actual color value as a hexadecimal number.
224224
* @return {Lut} A reference to this LUT.
225225
*/

examples/jsm/misc/Volume.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -234,7 +234,7 @@ class Volume {
234234
/**
235235
* The list of all the slices associated to this volume
236236
*
237-
* @type {Array}
237+
* @type {Array<VolumeSlice>}
238238
*/
239239
this.sliceList = [];
240240

examples/jsm/tsl/display/OutlineNode.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ class OutlineNode extends TempNode {
5656
* @param {Scene} scene - A reference to the scene.
5757
* @param {Camera} camera - The camera the scene is rendered with.
5858
* @param {Object} params - The configuration parameters.
59-
* @param {Array<Object3D>} params.selectedObjects - An array of selected objects.
59+
* @param {Array<Object3D>} [params.selectedObjects] - An array of selected objects.
6060
* @param {Node<float>} [params.edgeThickness=float(1)] - The thickness of the edges.
6161
* @param {Node<float>} [params.edgeGlow=float(0)] - Can be used for an animated glow/pulse effects.
6262
* @param {number} [params.downSampleRatio=2] - The downsample ratio.
@@ -742,7 +742,7 @@ export default OutlineNode;
742742
* @param {Scene} scene - A reference to the scene.
743743
* @param {Camera} camera - The camera the scene is rendered with.
744744
* @param {Object} params - The configuration parameters.
745-
* @param {Array<Object3D>} params.selectedObjects - An array of selected objects.
745+
* @param {Array<Object3D>} [params.selectedObjects] - An array of selected objects.
746746
* @param {Node<float>} [params.edgeThickness=float(1)] - The thickness of the edges.
747747
* @param {Node<float>} [params.edgeGlow=float(0)] - Can be used for animated glow/pulse effects.
748748
* @param {number} [params.downSampleRatio=2] - The downsample ratio.

src/materials/nodes/manager/NodeMaterialObserver.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -548,7 +548,7 @@ class NodeMaterialObserver {
548548
*
549549
* @param {LightsNode} lightsNode - The lights node.
550550
* @param {number} renderId - The render ID.
551-
* @return {Array} The lights for the given lights node and render ID.
551+
* @return {Array<Object>} The lights for the given lights node and render ID.
552552
*/
553553
getLights( lightsNode, renderId ) {
554554

src/nodes/accessors/BufferNode.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ export default BufferNode;
9393
*
9494
* @tsl
9595
* @function
96-
* @param {Array} value - Array-like buffer data.
96+
* @param {Array<number>} value - Array-like buffer data.
9797
* @param {string} type - The data type of a buffer element.
9898
* @param {number} count - The count of buffer elements.
9999
* @returns {BufferNode}

src/nodes/core/NodeBuilder.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2655,7 +2655,7 @@ class NodeBuilder {
26552655
/**
26562656
* Returns the closest sub-build layer for the given data.
26572657
*
2658-
* @param {Node|Set|Array} data - The data to get the closest sub-build layer from.
2658+
* @param {Node|Set<string>|Array<string>} data - The data to get the closest sub-build layer from.
26592659
* @return {?string} The closest sub-build name or null if none found.
26602660
*/
26612661
getClosestSubBuild( data ) {

src/nodes/core/NodeFrame.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ class NodeFrame {
115115
* @private
116116
* @param {WeakMap<Node, Object>} referenceMap - The reference weak map.
117117
* @param {Node} nodeRef - The reference to the current node.
118-
* @return {Object<string,WeakMap>} The dictionary.
118+
* @return {Object<string,WeakMap<Object, number>>} The dictionary.
119119
*/
120120
_getMaps( referenceMap, nodeRef ) {
121121

src/renderers/common/Backend.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ class Backend {
3838
* This weak map holds backend-specific data of objects
3939
* like textures, attributes or render targets.
4040
*
41-
* @type {WeakMap}
41+
* @type {WeakMap<Object, Object>}
4242
*/
4343
this.data = new WeakMap();
4444

src/renderers/common/ChainMap.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ class ChainMap {
1616
/**
1717
* The root Weak Map.
1818
*
19-
* @type {WeakMap}
19+
* @type {WeakMap<Object, WeakMap>}
2020
*/
2121
this.weakMap = new WeakMap();
2222

src/renderers/common/DataMap.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ class DataMap {
1515
* `DataMap` internally uses a weak map
1616
* to manage its data.
1717
*
18-
* @type {WeakMap}
18+
* @type {WeakMap<Object, Object>}
1919
*/
2020
this.data = new WeakMap();
2121

0 commit comments

Comments
 (0)