Skip to content

Commit 08c1ed6

Browse files
Rel1cxRel1cx
authored
refactor: update 'is-from-react' related utility functions to use dual api (#892)
1 parent 2b4e5b8 commit 08c1ed6

21 files changed

+428
-144
lines changed

‎packages/core/docs/functions/isCallFromReact.md‎

Lines changed: 2 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
# Function: isCallFromReact()
88

9-
> **isCallFromReact**(`name`): (`node`, `context`) => `boolean`
9+
> **isCallFromReact**(`name`): `IsCallFromReact`
1010
1111
## Parameters
1212

@@ -16,18 +16,4 @@
1616

1717
## Returns
1818

19-
`Function`
20-
21-
### Parameters
22-
23-
#### node
24-
25-
`CallExpression`
26-
27-
#### context
28-
29-
`Readonly`\<`RuleContext`\<`string`, readonly `unknown`[]\>\>
30-
31-
### Returns
32-
33-
`boolean`
19+
`IsCallFromReact`

‎packages/core/docs/functions/isCallFromReactMember.md‎

Lines changed: 2 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
# Function: isCallFromReactMember()
88

9-
> **isCallFromReactMember**(`pragmaMemberName`, `name`): (`node`, `context`) => `boolean`
9+
> **isCallFromReactMember**(`pragmaMemberName`, `name`): `IsCallFromReactMember`
1010
1111
## Parameters
1212

@@ -20,18 +20,4 @@
2020

2121
## Returns
2222

23-
`Function`
24-
25-
### Parameters
26-
27-
#### node
28-
29-
`CallExpression`
30-
31-
#### context
32-
33-
`Readonly`\<`RuleContext`\<`string`, readonly `unknown`[]\>\>
34-
35-
### Returns
36-
37-
`boolean`
23+
`IsCallFromReactMember`

‎packages/core/docs/functions/isChildrenCountCall.md‎

Lines changed: 33 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,44 @@
66

77
# Function: isChildrenCountCall()
88

9-
> **isChildrenCountCall**(`node`, `context`): `boolean`
9+
## Call Signature
1010

11-
## Parameters
11+
> **isChildrenCountCall**(`context`): (`node`) => `node is CallExpression & { callee: MemberExpression }`
1212
13-
### node
13+
### Parameters
1414

15-
`CallExpression`
15+
#### context
1616

17-
### context
17+
`Readonly`\<`RuleContext`\<`string`, readonly `unknown`[]\>\>
18+
19+
### Returns
20+
21+
`Function`
22+
23+
#### Parameters
24+
25+
##### node
26+
27+
`Node`
28+
29+
#### Returns
30+
31+
`node is CallExpression & { callee: MemberExpression }`
32+
33+
## Call Signature
34+
35+
> **isChildrenCountCall**(`node`, `context`): `node is CallExpression & { callee: MemberExpression }`
36+
37+
### Parameters
38+
39+
#### node
40+
41+
`Node`
42+
43+
#### context
1844

1945
`Readonly`\<`RuleContext`\<`string`, readonly `unknown`[]\>\>
2046

21-
## Returns
47+
### Returns
2248

23-
`boolean`
49+
`node is CallExpression & { callee: MemberExpression }`

‎packages/core/docs/functions/isChildrenForEachCall.md‎

Lines changed: 33 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,44 @@
66

77
# Function: isChildrenForEachCall()
88

9-
> **isChildrenForEachCall**(`node`, `context`): `boolean`
9+
## Call Signature
1010

11-
## Parameters
11+
> **isChildrenForEachCall**(`context`): (`node`) => `node is CallExpression & { callee: MemberExpression }`
1212
13-
### node
13+
### Parameters
1414

15-
`CallExpression`
15+
#### context
1616

17-
### context
17+
`Readonly`\<`RuleContext`\<`string`, readonly `unknown`[]\>\>
18+
19+
### Returns
20+
21+
`Function`
22+
23+
#### Parameters
24+
25+
##### node
26+
27+
`Node`
28+
29+
#### Returns
30+
31+
`node is CallExpression & { callee: MemberExpression }`
32+
33+
## Call Signature
34+
35+
> **isChildrenForEachCall**(`node`, `context`): `node is CallExpression & { callee: MemberExpression }`
36+
37+
### Parameters
38+
39+
#### node
40+
41+
`Node`
42+
43+
#### context
1844

1945
`Readonly`\<`RuleContext`\<`string`, readonly `unknown`[]\>\>
2046

21-
## Returns
47+
### Returns
2248

23-
`boolean`
49+
`node is CallExpression & { callee: MemberExpression }`

‎packages/core/docs/functions/isChildrenMapCall.md‎

Lines changed: 33 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,44 @@
66

77
# Function: isChildrenMapCall()
88

9-
> **isChildrenMapCall**(`node`, `context`): `boolean`
9+
## Call Signature
1010

11-
## Parameters
11+
> **isChildrenMapCall**(`context`): (`node`) => `node is CallExpression & { callee: MemberExpression }`
1212
13-
### node
13+
### Parameters
1414

15-
`CallExpression`
15+
#### context
1616

17-
### context
17+
`Readonly`\<`RuleContext`\<`string`, readonly `unknown`[]\>\>
18+
19+
### Returns
20+
21+
`Function`
22+
23+
#### Parameters
24+
25+
##### node
26+
27+
`Node`
28+
29+
#### Returns
30+
31+
`node is CallExpression & { callee: MemberExpression }`
32+
33+
## Call Signature
34+
35+
> **isChildrenMapCall**(`node`, `context`): `node is CallExpression & { callee: MemberExpression }`
36+
37+
### Parameters
38+
39+
#### node
40+
41+
`Node`
42+
43+
#### context
1844

1945
`Readonly`\<`RuleContext`\<`string`, readonly `unknown`[]\>\>
2046

21-
## Returns
47+
### Returns
2248

23-
`boolean`
49+
`node is CallExpression & { callee: MemberExpression }`

‎packages/core/docs/functions/isChildrenOfCreateElement.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,16 +8,24 @@
88

99
> **isChildrenOfCreateElement**(`node`, `context`): `boolean`
1010
11+
Determines whether inside `createElement`'s children.
12+
1113
## Parameters
1214

1315
### node
1416

1517
`Node`
1618

19+
The AST node to check
20+
1721
### context
1822

1923
`Readonly`\<`RuleContext`\<`string`, readonly `unknown`[]\>\>
2024

25+
The rule context
26+
2127
## Returns
2228

2329
`boolean`
30+
31+
`true` if the node is inside createElement's children

‎packages/core/docs/functions/isChildrenOnlyCall.md‎

Lines changed: 33 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,44 @@
66

77
# Function: isChildrenOnlyCall()
88

9-
> **isChildrenOnlyCall**(`node`, `context`): `boolean`
9+
## Call Signature
1010

11-
## Parameters
11+
> **isChildrenOnlyCall**(`context`): (`node`) => `node is CallExpression & { callee: MemberExpression }`
1212
13-
### node
13+
### Parameters
1414

15-
`CallExpression`
15+
#### context
1616

17-
### context
17+
`Readonly`\<`RuleContext`\<`string`, readonly `unknown`[]\>\>
18+
19+
### Returns
20+
21+
`Function`
22+
23+
#### Parameters
24+
25+
##### node
26+
27+
`Node`
28+
29+
#### Returns
30+
31+
`node is CallExpression & { callee: MemberExpression }`
32+
33+
## Call Signature
34+
35+
> **isChildrenOnlyCall**(`node`, `context`): `node is CallExpression & { callee: MemberExpression }`
36+
37+
### Parameters
38+
39+
#### node
40+
41+
`Node`
42+
43+
#### context
1844

1945
`Readonly`\<`RuleContext`\<`string`, readonly `unknown`[]\>\>
2046

21-
## Returns
47+
### Returns
2248

23-
`boolean`
49+
`node is CallExpression & { callee: MemberExpression }`

‎packages/core/docs/functions/isChildrenToArrayCall.md‎

Lines changed: 33 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,44 @@
66

77
# Function: isChildrenToArrayCall()
88

9-
> **isChildrenToArrayCall**(`node`, `context`): `boolean`
9+
## Call Signature
1010

11-
## Parameters
11+
> **isChildrenToArrayCall**(`context`): (`node`) => `node is CallExpression & { callee: MemberExpression }`
1212
13-
### node
13+
### Parameters
1414

15-
`CallExpression`
15+
#### context
1616

17-
### context
17+
`Readonly`\<`RuleContext`\<`string`, readonly `unknown`[]\>\>
18+
19+
### Returns
20+
21+
`Function`
22+
23+
#### Parameters
24+
25+
##### node
26+
27+
`Node`
28+
29+
#### Returns
30+
31+
`node is CallExpression & { callee: MemberExpression }`
32+
33+
## Call Signature
34+
35+
> **isChildrenToArrayCall**(`node`, `context`): `node is CallExpression & { callee: MemberExpression }`
36+
37+
### Parameters
38+
39+
#### node
40+
41+
`Node`
42+
43+
#### context
1844

1945
`Readonly`\<`RuleContext`\<`string`, readonly `unknown`[]\>\>
2046

21-
## Returns
47+
### Returns
2248

23-
`boolean`
49+
`node is CallExpression & { callee: MemberExpression }`

‎packages/core/docs/functions/isCloneElementCall.md‎

Lines changed: 33 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,44 @@
66

77
# Function: isCloneElementCall()
88

9-
> **isCloneElementCall**(`node`, `context`): `boolean`
9+
## Call Signature
1010

11-
## Parameters
11+
> **isCloneElementCall**(`context`): (`node`) => `node is CallExpression`
1212
13-
### node
13+
### Parameters
1414

15-
`CallExpression`
15+
#### context
1616

17-
### context
17+
`Readonly`\<`RuleContext`\<`string`, readonly `unknown`[]\>\>
18+
19+
### Returns
20+
21+
`Function`
22+
23+
#### Parameters
24+
25+
##### node
26+
27+
`Node`
28+
29+
#### Returns
30+
31+
`node is CallExpression`
32+
33+
## Call Signature
34+
35+
> **isCloneElementCall**(`node`, `context`): `node is CallExpression`
36+
37+
### Parameters
38+
39+
#### node
40+
41+
`Node`
42+
43+
#### context
1844

1945
`Readonly`\<`RuleContext`\<`string`, readonly `unknown`[]\>\>
2046

21-
## Returns
47+
### Returns
2248

23-
`boolean`
49+
`node is CallExpression`

0 commit comments

Comments
 (0)