Skip to content

Commit 937cbed

Browse files
committed
Add JSDoc type definitions
1 parent c2c2884 commit 937cbed

2 files changed

Lines changed: 32 additions & 0 deletions

File tree

tools/docs/jsdoc/typedefs/numbers.js

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,12 @@
8888
* @typedef {number} integer
8989
*/
9090

91+
/**
92+
* An unsigned integer.
93+
*
94+
* @typedef {number} uinteger
95+
*/
96+
9197
/**
9298
* A number primitive which has an integer value on the interval `[-2147483648, 2147483647]`. This number may be interpreted by the runtime engine as a 32-bit integer, which may very well be the case after performing bitwise operations; e.g., `3.14|0`.
9399
*

tools/docs/jsdoc/typedefs/objects.js

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,12 @@
44
* @typedef {(Array|string|String|Object)} ArrayLike
55
*/
66

7+
/**
8+
* An array-like object (excluding string primitives).
9+
*
10+
* @typedef {(Array|String|Object)} ArrayLikeObject
11+
*/
12+
713
/**
814
* A plain object; i.e., either `{}` or an object created via `Object.create( null )`.
915
*
@@ -24,6 +30,26 @@
2430
* @see [JSON]{@link http://www.json.org/}
2531
*/
2632

33+
/**
34+
* A node of the abstract syntax tree (AST) from ESTree.
35+
*
36+
* @typedef {Object} ASTNode
37+
*
38+
* @see [ESTree]{@link https://github.com/estree/estree}
39+
*/
40+
41+
/**
42+
* A benchmark instance.
43+
*
44+
* @typedef {Object} Benchmark
45+
*/
46+
47+
/**
48+
* A weight vector of model coefficients.
49+
*
50+
* @typedef {Object} WeightVector
51+
*/
52+
2753
/**
2854
* An object containing function options.
2955
*

0 commit comments

Comments
 (0)