Skip to content

Commit 65451d5

Browse files
committed
Refactor code-style
* Add more docs to JSDoc * Add support for `null` in input of API types
1 parent 23c71e2 commit 65451d5

File tree

1 file changed

+10
-8
lines changed

1 file changed

+10
-8
lines changed

lib/index.js

+10-8
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,24 @@
11
/**
22
* @typedef PointLike
3-
* @property {number} [line]
4-
* @property {number} [column]
5-
* @property {number} [offset]
3+
* @property {number | null | undefined} [line]
4+
* @property {number | null | undefined} [column]
5+
* @property {number | null | undefined} [offset]
66
*
77
* @typedef PositionLike
8-
* @property {PointLike} [start]
9-
* @property {PointLike} [end]
8+
* @property {PointLike | null | undefined} [start]
9+
* @property {PointLike | null | undefined} [end]
1010
*
1111
* @typedef NodeLike
12-
* @property {PositionLike} [position]
12+
* @property {PositionLike | null | undefined} [position]
1313
*/
1414

1515
/**
16-
* Check if `node` is *generated*.
16+
* Check if `node` is generated.
1717
*
18-
* @param {NodeLike} [node]
18+
* @param {NodeLike | null | undefined} [node]
19+
* Node to check.
1920
* @returns {boolean}
21+
* Whether `node` is generated (does not have positional info).
2022
*/
2123
export function generated(node) {
2224
return (

0 commit comments

Comments
 (0)