Skip to content

Commit d216b10

Browse files
Esemesekthymikee
authored andcommitted
fix: correct Flow and TS typings for a11y queries (#205)
1 parent 1382a3d commit d216b10

File tree

2 files changed

+19
-13
lines changed

2 files changed

+19
-13
lines changed

src/helpers/a11yAPI.js

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,29 +2,33 @@
22
import makeQuery from './makeQuery';
33

44
type QueryFn = (string | RegExp) => ReactTestInstance | null;
5+
type QueryAllFn = (string | RegExp) => Array<ReactTestInstance> | [];
56
type GetFn = (string | RegExp) => ReactTestInstance;
6-
type GetAllFn = (string | RegExp) => Array<ReactTestInstance> | [];
7+
type GetAllFn = (string | RegExp) => Array<ReactTestInstance>;
78
type ArrayQueryFn = (string | Array<string>) => ReactTestInstance | null;
9+
type ArrayQueryAllFn = (
10+
string | Array<string>
11+
) => Array<ReactTestInstance> | [];
812
type ArrayGetFn = (string | Array<string>) => ReactTestInstance;
9-
type ArrayGetAllFn = (string | Array<string>) => Array<ReactTestInstance> | [];
13+
type ArrayGetAllFn = (string | Array<string>) => Array<ReactTestInstance>;
1014

1115
type A11yAPI = {
1216
getByA11yLabel: GetFn,
1317
getAllByA11yLabel: GetAllFn,
1418
queryByA11yLabel: QueryFn,
15-
queryAllByA11yLabel: GetAllFn,
19+
queryAllByA11yLabel: QueryAllFn,
1620
getByA11yHint: GetFn,
1721
getAllByA11yHint: GetAllFn,
1822
queryByA11yHint: QueryFn,
19-
queryAllByA11yHint: GetAllFn,
23+
queryAllByA11yHint: QueryAllFn,
2024
getByA11yRole: GetFn,
2125
getAllByA11yRole: GetAllFn,
2226
queryByA11yRole: QueryFn,
23-
queryAllByA11yRole: GetAllFn,
27+
queryAllByA11yRole: QueryAllFn,
2428
getByA11yStates: ArrayGetFn,
2529
getAllByA11yStates: ArrayGetAllFn,
2630
queryByA11yStates: ArrayQueryFn,
27-
queryAllByA11yStates: ArrayGetAllFn,
31+
queryAllByA11yStates: ArrayQueryAllFn,
2832
};
2933

3034
export function matchStringValue(prop?: string, matcher: string | RegExp) {

typings/index.d.ts

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -50,31 +50,33 @@ export interface QueryByAPI {
5050
}
5151

5252
type QueryFn = (text: string | RegExp) => ReactTestInstance | null;
53+
type QueryAllFn = (text: string | RegExp) => Array<ReactTestInstance> | [];
5354
type GetFn = (text: string | RegExp) => ReactTestInstance;
54-
type GetAllFn = (text: string | RegExp) => Array<ReactTestInstance> | [];
55+
type GetAllFn = (text: string | RegExp) => Array<ReactTestInstance>;
5556
type ArrayQueryFn = (text: string | Array<string>) => ReactTestInstance | null;
56-
type ArrayGetFn = (text: string | Array<string>) => ReactTestInstance;
57-
type ArrayGetAllFn = (
57+
type ArrayQueryAllFn = (
5858
text: string | Array<string>
5959
) => Array<ReactTestInstance> | [];
60+
type ArrayGetFn = (text: string | Array<string>) => ReactTestInstance;
61+
type ArrayGetAllFn = (text: string | Array<string>) => Array<ReactTestInstance>;
6062

6163
export interface A11yAPI {
6264
getByA11yLabel: GetFn;
6365
getAllByA11yLabel: GetAllFn;
6466
queryByA11yLabel: QueryFn;
65-
queryAllByA11yLabel: GetAllFn;
67+
queryAllByA11yLabel: QueryAllFn;
6668
getByA11yHint: GetFn;
6769
getAllByA11yHint: GetAllFn;
6870
queryByA11yHint: QueryFn;
69-
queryAllByA11yHint: GetAllFn;
71+
queryAllByA11yHint: QueryAllFn;
7072
getByA11yRole: GetFn;
7173
getAllByA11yRole: GetAllFn;
7274
queryByA11yRole: QueryFn;
73-
queryAllByA11yRole: GetAllFn;
75+
queryAllByA11yRole: QueryAllFn;
7476
getByA11yStates: ArrayGetFn;
7577
getAllByA11yStates: ArrayGetAllFn;
7678
queryByA11yStates: ArrayQueryFn;
77-
queryAllByA11yStates: ArrayGetAllFn;
79+
queryAllByA11yStates: ArrayQueryAllFn;
7880
}
7981

8082
export interface Thenable {

0 commit comments

Comments
 (0)