Skip to content

Commit 42278fe

Browse files
committed
refactor: remove redundant JSDoc comments from string and identifier utility functions
1 parent 0663480 commit 42278fe

File tree

1 file changed

+0
-47
lines changed

1 file changed

+0
-47
lines changed

lib/node-utils/accessors.ts

Lines changed: 0 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -17,13 +17,6 @@ interface StringLiteral<Value extends string = string>
1717
*
1818
* If a `value` is provided & the `node` is a `StringLiteral`,
1919
* the `value` will be compared to that of the `StringLiteral`.
20-
*
21-
* @param {Node} node
22-
* @param {V} [value]
23-
*
24-
* @return {node is StringLiteral<V>}
25-
*
26-
* @template V
2720
*/
2821
const isStringLiteral = <V extends string>(
2922
node: TSESTree.Node,
@@ -45,13 +38,6 @@ interface TemplateLiteral<Value extends string = string>
4538
*
4639
* If a `value` is provided & the `node` is a `TemplateLiteral`,
4740
* the `value` will be compared to that of the `TemplateLiteral`.
48-
*
49-
* @param {Node} node
50-
* @param {V} [value]
51-
*
52-
* @return {node is TemplateLiteral<V>}
53-
*
54-
* @template V
5541
*/
5642
const isTemplateLiteral = <V extends string>(
5743
node: TSESTree.Node,
@@ -67,13 +53,6 @@ export type StringNode<S extends string = string> =
6753

6854
/**
6955
* Checks if the given `node` is a {@link StringNode}.
70-
*
71-
* @param {Node} node
72-
* @param {V} [specifics]
73-
*
74-
* @return {node is StringNode}
75-
*
76-
* @template V
7756
*/
7857
export const isStringNode = <V extends string>(
7958
node: TSESTree.Node,
@@ -86,12 +65,6 @@ export const isStringNode = <V extends string>(
8665
*
8766
* If the `node` is a `TemplateLiteral`, the `raw` value is used;
8867
* otherwise, `value` is returned instead.
89-
*
90-
* @param {StringNode<S>} node
91-
*
92-
* @return {S}
93-
*
94-
* @template S
9568
*/
9669
export const getStringValue = <S extends string>(node: StringNode<S>): S =>
9770
isTemplateLiteral(node) ? node.quasis[0].value.raw : node.value;
@@ -108,13 +81,6 @@ interface KnownIdentifier<Name extends string> extends TSESTree.Identifier {
10881
*
10982
* If a `name` is provided, & the `node` is an `Identifier`,
11083
* the `name` will be compared to that of the `identifier`.
111-
*
112-
* @param {Node} node
113-
* @param {V} [name]
114-
*
115-
* @return {node is KnownIdentifier<Name>}
116-
*
117-
* @template V
11884
*/
11985
export const isIdentifier = <V extends string>(
12086
node: TSESTree.Node,
@@ -136,13 +102,6 @@ export const isIdentifier = <V extends string>(
136102
*
137103
* Note that `value` here refers to the normalised value.
138104
* The property that holds the value is not always called `name`.
139-
*
140-
* @param {Node} node
141-
* @param {V} [value]
142-
*
143-
* @return {node is AccessorNode<V>}
144-
*
145-
* @template V
146105
*/
147106
export const isSupportedAccessor = <V extends string>(
148107
node: TSESTree.Node,
@@ -153,12 +112,6 @@ export const isSupportedAccessor = <V extends string>(
153112
/**
154113
* Gets the value of the given `AccessorNode`,
155114
* account for the different node types.
156-
*
157-
* @param {AccessorNode<S>} accessor
158-
*
159-
* @return {S}
160-
*
161-
* @template S
162115
*/
163116
export const getAccessorValue = <S extends string = string>(
164117
accessor: AccessorNode<S>

0 commit comments

Comments
 (0)