@testing-library/react-native 7.2.0 → 9.0.0-alpha.0

package/README.md

@@ -4,7 +4,7 @@
     height="80"
     width="80"
     alt="owl"
-    src="https://raw.githubusercontent.com/callstack/react-native-testing-library/master/website/static/img/owl.png"
+    src="https://raw.githubusercontent.com/callstack/react-native-testing-library/main/website/static/img/owl.png"
   />
   <p>Simple and complete React Native testing utilities that encourage good testing practices.</P>
 </div>
@@ -46,7 +46,7 @@ npm install --save-dev @testing-library/react-native
 
 This library has a peerDependencies listing for `react-test-renderer` and, of course, `react`. Make sure to install them too!
 
-> In order to properly use helpers for async tests (`findBy` queries and `waitFor`) you need at least React >=16.9.0 (featuring async `act`) or React Native >=0.60 (which comes with React >=16.9.0).
+> In order to properly use helpers for async tests (`findBy` queries and `waitFor`) you need at least React >=16.9.0 (featuring async `act`) or React Native >=0.61 (which comes with React >=16.9.0).
 
 ### Additional Jest matchers
 
@@ -73,6 +73,24 @@ Then automatically add it to your jest tests by using `setupFilesAfterEnv` optio
 }
 ```
 
+### Custom Jest Preset
+
+> **important** if you use "modern" Fake Timers
+
+We generally advise to use the "react-native" preset when testing with this library. However, if you use ["modern" Fake Timers](https://jestjs.io/blog/2020/05/05/jest-26#new-fake-timers) (default since Jest 27), you'll need to apply our custom Jest preset or awaiting promises, like `waitFor`, will timeout.
+
+This is a [known issue](https://github.com/facebook/react-native/issues/29303). It happens because React Native's Jest preset overrides native Promise. Our preset restores it to defaults, which is not a problem in most apps out there.
+
+Here's how you apply a custom preset in your Jest config:
+
+```json
+{
+  "preset": "@testing-library/react-native"
+}
+```
+
+If this doesn't work for you, please fall back to using "legacy" fake timers.
+
 ### Flow
 
 Note for [Flow](https://flow.org) users – you'll also need to install typings for `react-test-renderer`:
@@ -108,7 +126,7 @@ test('form submits two answers', () => {
 });
 ```
 
-You can find the source of `QuestionsBoard` component and this example [here](https://github.com/callstack/react-native-testing-library/blob/master/src/__tests__/questionsBoard.test.js).
+You can find the source of `QuestionsBoard` component and this example [here](https://github.com/callstack/react-native-testing-library/blob/main/src/__tests__/questionsBoard.test.js).
 
 ## API / Usage
 
@@ -135,6 +153,8 @@ The [public API](https://callstack.github.io/react-native-testing-library/docs/a
 
 React Native Testing Library is an open source project and will always remain free to use. If you think it's cool, please star it 🌟. [Callstack](https://callstack.com) is a group of React and React Native geeks, contact us at [hello@callstack.com](mailto:hello@callstack.com) if you need any help with these or just want to say hi!
 
+Like the project? ⚛️ [Join the team](https://callstack.com/careers/?utm_campaign=Senior_RN&utm_source=github&utm_medium=readme) who does amazing stuff for clients and drives React Native Open Source! 🔥
+
 ---
 
 Supported and used by [Rally Health](https://www.rallyhealth.com/careers-home).

package/build/fireEvent.js

@@ -7,8 +7,6 @@ exports.default = void 0;
 
 var _act = _interopRequireDefault(require("./act"));
 
-var _errors = require("./helpers/errors");
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
 const isHostElement = element => {
@@ -50,22 +48,16 @@ const isEventEnabled = (element, touchResponder) => {
   return touchStart === undefined && touchMove === undefined;
 };
 
-const findEventHandler = (element, eventName, callsite, nearestTouchResponder, hasDescendandHandler) => {
+const findEventHandler = (element, eventName, callsite, nearestTouchResponder) => {
   const touchResponder = isTouchResponder(element) ? element : nearestTouchResponder;
   const handler = getEventHandler(element, eventName);
-  if (handler && isEventEnabled(element, touchResponder)) return handler; // Do not bubble event to the root element
-
-  const hasHandler = handler != null || hasDescendandHandler;
+  if (handler && isEventEnabled(element, touchResponder)) return handler;
 
   if (element.parent === null || element.parent.parent === null) {
-    if (hasHandler) {
-      return null;
-    } else {
-      throw new _errors.ErrorWithStack(`No handler function found for event: "${eventName}"`, callsite || invokeEvent);
-    }
+    return null;
   }
 
-  return findEventHandler(element.parent, eventName, callsite, touchResponder, hasHandler);
+  return findEventHandler(element.parent, eventName, callsite, touchResponder);
 };
 
 const getEventHandler = (element, eventName) => {
@@ -98,7 +90,7 @@ const invokeEvent = (element, eventName, callsite, ...data) => {
 
 const toEventHandlerName = eventName => `on${eventName.charAt(0).toUpperCase()}${eventName.slice(1)}`;
 
-const pressHandler = element => invokeEvent(element, 'press', pressHandler);
+const pressHandler = (element, ...data) => invokeEvent(element, 'press', pressHandler, ...data);
 
 const changeTextHandler = (element, ...data) => invokeEvent(element, 'changeText', changeTextHandler, ...data);
 

package/build/fireEvent.js.flow

@@ -1,6 +1,5 @@
 // @flow
 import act from './act';
-import { ErrorWithStack } from './helpers/errors';
 
 const isHostElement = (element?: ReactTestInstance) => {
   return typeof element?.type === 'string';
@@ -53,8 +52,7 @@ const findEventHandler = (
   element: ReactTestInstance,
   eventName: string,
   callsite?: any,
-  nearestTouchResponder?: ReactTestInstance,
-  hasDescendandHandler?: boolean
+  nearestTouchResponder?: ReactTestInstance
 ) => {
   const touchResponder = isTouchResponder(element)
     ? element
@@ -63,26 +61,11 @@ const findEventHandler = (
   const handler = getEventHandler(element, eventName);
   if (handler && isEventEnabled(element, touchResponder)) return handler;
 
-  // Do not bubble event to the root element
-  const hasHandler = handler != null || hasDescendandHandler;
   if (element.parent === null || element.parent.parent === null) {
-    if (hasHandler) {
-      return null;
-    } else {
-      throw new ErrorWithStack(
-        `No handler function found for event: "${eventName}"`,
-        callsite || invokeEvent
-      );
-    }
+    return null;
   }
 
-  return findEventHandler(
-    element.parent,
-    eventName,
-    callsite,
-    touchResponder,
-    hasHandler
-  );
+  return findEventHandler(element.parent, eventName, callsite, touchResponder);
 };
 
 const getEventHandler = (element: ReactTestInstance, eventName: string) => {
@@ -122,8 +105,8 @@ const invokeEvent = (
 const toEventHandlerName = (eventName: string) =>
   `on${eventName.charAt(0).toUpperCase()}${eventName.slice(1)}`;
 
-const pressHandler = (element: ReactTestInstance): void =>
-  invokeEvent(element, 'press', pressHandler);
+const pressHandler = (element: ReactTestInstance, ...data: Array<any>): void =>
+  invokeEvent(element, 'press', pressHandler, ...data);
 const changeTextHandler = (
   element: ReactTestInstance,
   ...data: Array<any>

package/build/flushMicroTasks.js

@@ -8,6 +8,8 @@ exports.flushMicroTasks = flushMicroTasks;
 
 var _errors = require("./helpers/errors");
 
+var _timers = require("./helpers/timers");
+
 /**
  * Wait for microtasks queue to flush
  */
@@ -21,7 +23,7 @@ function flushMicroTasks() {
     // using "thenable" instead of a Promise, because otherwise it breaks when
     // using "modern" fake timers
     then(resolve) {
-      setImmediate(resolve);
+      (0, _timers.setImmediate)(resolve);
     }
 
   };

package/build/flushMicroTasks.js.flow

@@ -1,5 +1,6 @@
 // @flow
 import { printDeprecationWarning } from './helpers/errors';
+import { setImmediate } from './helpers/timers';
 
 type Thenable<T> = { then: (() => T) => mixed };
 

package/build/helpers/byDisplayValue.js

@@ -5,27 +5,33 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.queryByDisplayValue = exports.queryAllByDisplayValue = exports.getByDisplayValue = exports.getAllByDisplayValue = exports.findByDisplayValue = exports.findAllByDisplayValue = void 0;
 
+var _matches = require("../matches");
+
 var _makeQueries = require("./makeQueries");
 
 var _filterNodeByType = require("./filterNodeByType");
 
 var _errors = require("./errors");
 
-const getTextInputNodeByDisplayValue = (node, value) => {
+const getTextInputNodeByDisplayValue = (node, value, options = {}) => {
   try {
     const {
       TextInput
     } = require('react-native');
 
+    const {
+      exact,
+      normalizer
+    } = options;
     const nodeValue = node.props.value !== undefined ? node.props.value : node.props.defaultValue;
-    return (0, _filterNodeByType.filterNodeByType)(node, TextInput) && (typeof value === 'string' ? value === nodeValue : value.test(nodeValue));
+    return (0, _filterNodeByType.filterNodeByType)(node, TextInput) && (0, _matches.matches)(value, nodeValue, normalizer, exact);
   } catch (error) {
     throw (0, _errors.createLibraryNotSupportedError)(error);
   }
 };
 
-const queryAllByDisplayValue = instance => function queryAllByDisplayValueFn(displayValue) {
-  return instance.findAll(node => getTextInputNodeByDisplayValue(node, displayValue));
+const queryAllByDisplayValue = instance => function queryAllByDisplayValueFn(displayValue, queryOptions) {
+  return instance.findAll(node => getTextInputNodeByDisplayValue(node, displayValue, queryOptions));
 };
 
 exports.queryAllByDisplayValue = queryAllByDisplayValue;

package/build/helpers/byDisplayValue.js.flow

@@ -1,19 +1,26 @@
 // @flow
+import { matches } from '../matches';
 import { makeQueries } from './makeQueries';
 import type { Queries } from './makeQueries';
 import { filterNodeByType } from './filterNodeByType';
 import { createLibraryNotSupportedError } from './errors';
+import type { TextMatchOptions } from './byText';
 
-const getTextInputNodeByDisplayValue = (node, value) => {
+const getTextInputNodeByDisplayValue = (
+  node,
+  value,
+  options?: TextMatchOptions = {}
+) => {
   try {
     const { TextInput } = require('react-native');
+    const { exact, normalizer } = options;
     const nodeValue =
       node.props.value !== undefined
         ? node.props.value
         : node.props.defaultValue;
     return (
       filterNodeByType(node, TextInput) &&
-      (typeof value === 'string' ? value === nodeValue : value.test(nodeValue))
+      matches(value, nodeValue, normalizer, exact)
     );
   } catch (error) {
     throw createLibraryNotSupportedError(error);
@@ -22,10 +29,13 @@ const getTextInputNodeByDisplayValue = (node, value) => {
 
 const queryAllByDisplayValue = (
   instance: ReactTestInstance
-): ((displayValue: string | RegExp) => Array<ReactTestInstance>) =>
-  function queryAllByDisplayValueFn(displayValue) {
+): ((
+  displayValue: string | RegExp,
+  queryOptions?: TextMatchOptions
+) => Array<ReactTestInstance>) =>
+  function queryAllByDisplayValueFn(displayValue, queryOptions) {
     return instance.findAll((node) =>
-      getTextInputNodeByDisplayValue(node, displayValue)
+      getTextInputNodeByDisplayValue(node, displayValue, queryOptions)
     );
   };
 

package/build/helpers/byPlaceholderText.js

@@ -5,26 +5,32 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.queryByPlaceholderText = exports.queryAllByPlaceholderText = exports.getByPlaceholderText = exports.getAllByPlaceholderText = exports.findByPlaceholderText = exports.findAllByPlaceholderText = void 0;
 
+var _matches = require("../matches");
+
 var _makeQueries = require("./makeQueries");
 
 var _filterNodeByType = require("./filterNodeByType");
 
 var _errors = require("./errors");
 
-const getTextInputNodeByPlaceholderText = (node, placeholder) => {
+const getTextInputNodeByPlaceholderText = (node, placeholder, options = {}) => {
   try {
     const {
       TextInput
     } = require('react-native');
 
-    return (0, _filterNodeByType.filterNodeByType)(node, TextInput) && (typeof placeholder === 'string' ? placeholder === node.props.placeholder : placeholder.test(node.props.placeholder));
+    const {
+      exact,
+      normalizer
+    } = options;
+    return (0, _filterNodeByType.filterNodeByType)(node, TextInput) && (0, _matches.matches)(placeholder, node.props.placeholder, normalizer, exact);
   } catch (error) {
     throw (0, _errors.createLibraryNotSupportedError)(error);
   }
 };
 
-const queryAllByPlaceholderText = instance => function queryAllByPlaceholderFn(placeholder) {
-  return instance.findAll(node => getTextInputNodeByPlaceholderText(node, placeholder));
+const queryAllByPlaceholderText = instance => function queryAllByPlaceholderFn(placeholder, queryOptions) {
+  return instance.findAll(node => getTextInputNodeByPlaceholderText(node, placeholder, queryOptions));
 };
 
 exports.queryAllByPlaceholderText = queryAllByPlaceholderText;

package/build/helpers/byPlaceholderText.js.flow

@@ -1,17 +1,22 @@
 // @flow
+import { matches } from '../matches';
 import { makeQueries } from './makeQueries';
 import type { Queries } from './makeQueries';
 import { filterNodeByType } from './filterNodeByType';
 import { createLibraryNotSupportedError } from './errors';
+import type { TextMatchOptions } from './byText';
 
-const getTextInputNodeByPlaceholderText = (node, placeholder) => {
+const getTextInputNodeByPlaceholderText = (
+  node,
+  placeholder,
+  options?: TextMatchOptions = {}
+) => {
   try {
     const { TextInput } = require('react-native');
+    const { exact, normalizer } = options;
     return (
       filterNodeByType(node, TextInput) &&
-      (typeof placeholder === 'string'
-        ? placeholder === node.props.placeholder
-        : placeholder.test(node.props.placeholder))
+      matches(placeholder, node.props.placeholder, normalizer, exact)
     );
   } catch (error) {
     throw createLibraryNotSupportedError(error);
@@ -20,10 +25,13 @@ const getTextInputNodeByPlaceholderText = (node, placeholder) => {
 
 const queryAllByPlaceholderText = (
   instance: ReactTestInstance
-): ((placeholder: string | RegExp) => Array<ReactTestInstance>) =>
-  function queryAllByPlaceholderFn(placeholder) {
+): ((
+  placeholder: string | RegExp,
+  queryOptions?: TextMatchOptions
+) => Array<ReactTestInstance>) =>
+  function queryAllByPlaceholderFn(placeholder, queryOptions) {
     return instance.findAll((node) =>
-      getTextInputNodeByPlaceholderText(node, placeholder)
+      getTextInputNodeByPlaceholderText(node, placeholder, queryOptions)
     );
   };
 

package/build/helpers/byTestId.js

@@ -5,14 +5,20 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.queryByTestId = exports.queryAllByTestId = exports.getByTestId = exports.getAllByTestId = exports.findByTestId = exports.findAllByTestId = void 0;
 
+var _matches = require("../matches");
+
 var _makeQueries = require("./makeQueries");
 
-const getNodeByTestId = (node, testID) => {
-  return typeof testID === 'string' ? testID === node.props.testID : testID.test(node.props.testID);
+const getNodeByTestId = (node, testID, options = {}) => {
+  const {
+    exact,
+    normalizer
+  } = options;
+  return (0, _matches.matches)(testID, node.props.testID, normalizer, exact);
 };
 
-const queryAllByTestId = instance => function queryAllByTestIdFn(testId) {
-  const results = instance.findAll(node => getNodeByTestId(node, testId)).filter(element => typeof element.type === 'string');
+const queryAllByTestId = instance => function queryAllByTestIdFn(testId, queryOptions) {
+  const results = instance.findAll(node => getNodeByTestId(node, testId, queryOptions)).filter(element => typeof element.type === 'string');
   return results;
 };
 

package/build/helpers/byTestId.js.flow

@@ -1,19 +1,23 @@
 // @flow
+import { matches } from '../matches';
 import { makeQueries } from './makeQueries';
 import type { Queries } from './makeQueries';
+import type { TextMatchOptions } from './byText';
 
-const getNodeByTestId = (node, testID) => {
-  return typeof testID === 'string'
-    ? testID === node.props.testID
-    : testID.test(node.props.testID);
+const getNodeByTestId = (node, testID, options?: TextMatchOptions = {}) => {
+  const { exact, normalizer } = options;
+  return matches(testID, node.props.testID, normalizer, exact);
 };
 
 const queryAllByTestId = (
   instance: ReactTestInstance
-): ((testId: string | RegExp) => Array<ReactTestInstance>) =>
-  function queryAllByTestIdFn(testId) {
+): ((
+  testId: string | RegExp,
+  queryOptions?: TextMatchOptions
+) => Array<ReactTestInstance>) =>
+  function queryAllByTestIdFn(testId, queryOptions) {
     const results = instance
-      .findAll((node) => getNodeByTestId(node, testId))
+      .findAll((node) => getNodeByTestId(node, testId, queryOptions))
       .filter((element) => typeof element.type === 'string');
 
     return results;

package/build/helpers/byText.js

@@ -7,6 +7,8 @@ exports.queryByText = exports.queryAllByText = exports.getByText = exports.getAl
 
 var React = _interopRequireWildcard(require("react"));
 
+var _matches = require("../matches");
+
 var _makeQueries = require("./makeQueries");
 
 var _filterNodeByType = require("./filterNodeByType");
@@ -17,7 +19,8 @@ function _getRequireWildcardCache() { if (typeof WeakMap !== "function") return
 
 function _interopRequireWildcard(obj) { if (obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
 
-const getChildrenAsText = (children, TextComponent, textContent = []) => {
+const getChildrenAsText = (children, TextComponent) => {
+  const textContent = [];
   React.Children.forEach(children, child => {
     var _child$props;
 
@@ -40,13 +43,13 @@ const getChildrenAsText = (children, TextComponent, textContent = []) => {
         return;
       }
 
-      getChildrenAsText(child.props.children, TextComponent, textContent);
+      getChildrenAsText(child.props.children, TextComponent);
     }
   });
   return textContent;
 };
 
-const getNodeByText = (node, text) => {
+const getNodeByText = (node, text, options = {}) => {
   try {
     const {
       Text
@@ -59,7 +62,11 @@ const getNodeByText = (node, text) => {
 
       if (textChildren) {
         const textToTest = textChildren.join('');
-        return typeof text === 'string' ? text === textToTest : text.test(textToTest);
+        const {
+          exact,
+          normalizer
+        } = options;
+        return (0, _matches.matches)(text, textToTest, normalizer, exact);
       }
     }
 
@@ -69,8 +76,8 @@ const getNodeByText = (node, text) => {
   }
 };
 
-const queryAllByText = instance => function queryAllByTextFn(text) {
-  const results = instance.findAll(node => getNodeByText(node, text));
+const queryAllByText = instance => function queryAllByTextFn(text, queryOptions) {
+  const results = instance.findAll(node => getNodeByText(node, text, queryOptions));
   return results;
 };
 

package/build/helpers/byText.js.flow

@@ -1,11 +1,19 @@
 // @flow
 import * as React from 'react';
+import { matches } from '../matches';
+import type { NormalizerFn } from '../matches';
 import { makeQueries } from './makeQueries';
 import type { Queries } from './makeQueries';
 import { filterNodeByType } from './filterNodeByType';
 import { createLibraryNotSupportedError } from './errors';
 
-const getChildrenAsText = (children, TextComponent, textContent = []) => {
+export type TextMatchOptions = {
+  exact?: boolean,
+  normalizer?: NormalizerFn,
+};
+
+const getChildrenAsText = (children, TextComponent) => {
+  const textContent = [];
   React.Children.forEach(children, (child) => {
     if (typeof child === 'string') {
       textContent.push(child);
@@ -26,14 +34,18 @@ const getChildrenAsText = (children, TextComponent, textContent = []) => {
         return;
       }
 
-      getChildrenAsText(child.props.children, TextComponent, textContent);
+      getChildrenAsText(child.props.children, TextComponent);
     }
   });
 
   return textContent;
 };
 
-const getNodeByText = (node, text: string | RegExp) => {
+const getNodeByText = (
+  node,
+  text: string | RegExp,
+  options?: TextMatchOptions = {}
+) => {
   try {
     const { Text } = require('react-native');
     const isTextComponent = filterNodeByType(node, Text);
@@ -41,9 +53,8 @@ const getNodeByText = (node, text: string | RegExp) => {
       const textChildren = getChildrenAsText(node.props.children, Text);
       if (textChildren) {
         const textToTest = textChildren.join('');
-        return typeof text === 'string'
-          ? text === textToTest
-          : text.test(textToTest);
+        const { exact, normalizer } = options;
+        return matches(text, textToTest, normalizer, exact);
       }
     }
     return false;
@@ -54,9 +65,14 @@ const getNodeByText = (node, text: string | RegExp) => {
 
 const queryAllByText = (
   instance: ReactTestInstance
-): ((text: string | RegExp) => Array<ReactTestInstance>) =>
-  function queryAllByTextFn(text) {
-    const results = instance.findAll((node) => getNodeByText(node, text));
+): ((
+  text: string | RegExp,
+  queryOptions?: TextMatchOptions
+) => Array<ReactTestInstance>) =>
+  function queryAllByTextFn(text, queryOptions) {
+    const results = instance.findAll((node) =>
+      getNodeByText(node, text, queryOptions)
+    );
 
     return results;
   };

package/build/helpers/errors.js

@@ -64,7 +64,8 @@ const warned = {};
 function printDeprecationWarning(functionName) {
   if (warned[functionName]) {
     return;
-  }
+  } // eslint-disable-next-line no-console
+
 
   console.warn(`
   Deprecation Warning:

package/build/helpers/errors.js.flow

@@ -53,6 +53,7 @@ export function printDeprecationWarning(functionName: string) {
     return;
   }
 
+  // eslint-disable-next-line no-console
   console.warn(`
   Deprecation Warning:
   Use of ${functionName} is not recommended and will be deleted in future versions of @testing-library/react-native.

package/build/helpers/findByAPI.js.flow

@@ -1,5 +1,6 @@
 // @flow
 import type { WaitForOptions } from '../waitFor';
+import type { TextMatchOptions } from './byText';
 import { findAllByTestId, findByTestId } from './byTestId';
 import { findAllByText, findByText } from './byText';
 import {
@@ -12,36 +13,44 @@ import { throwRenamedFunctionError } from './errors';
 export type FindByAPI = {|
   findAllByDisplayValue: (
     value: string | RegExp,
+    queryOptions?: TextMatchOptions & WaitForOptions,
     waitForOptions?: WaitForOptions
   ) => Promise<Array<ReactTestInstance>>,
   findAllByPlaceholder: () => void,
   findAllByPlaceholderText: (
     placeholder: string | RegExp,
+    queryOptions?: TextMatchOptions & WaitForOptions,
     waitForOptions?: WaitForOptions
   ) => Promise<Array<ReactTestInstance>>,
   findAllByTestId: (
     testId: string | RegExp,
+    queryOptions?: TextMatchOptions & WaitForOptions,
     waitForOptions?: WaitForOptions
   ) => Promise<Array<ReactTestInstance>>,
   findAllByText: (
     text: string | RegExp,
+    queryOptions?: TextMatchOptions & WaitForOptions,
     waitForOptions?: WaitForOptions
   ) => Promise<Array<ReactTestInstance>>,
   findByDisplayValue: (
     value: string | RegExp,
+    queryOptions?: TextMatchOptions & WaitForOptions,
     waitForOptions?: WaitForOptions
   ) => Promise<ReactTestInstance>,
   findByPlaceholder: () => void,
   findByPlaceholderText: (
     placeholder: string | RegExp,
+    queryOptions?: TextMatchOptions & WaitForOptions,
     waitForOptions?: WaitForOptions
   ) => Promise<ReactTestInstance>,
   findByTestId: (
     testId: string | RegExp,
+    queryOptions?: TextMatchOptions & WaitForOptions,
     waitForOptions?: WaitForOptions
   ) => Promise<ReactTestInstance>,
   findByText: (
     text: string | RegExp,
+    queryOptions?: TextMatchOptions & WaitForOptions,
     waitForOptions?: WaitForOptions
   ) => Promise<ReactTestInstance>,
 |};

package/build/helpers/getByAPI.js.flow

@@ -14,18 +14,41 @@ import {
   getByPlaceholderText,
 } from './byPlaceholderText';
 import { getAllByDisplayValue, getByDisplayValue } from './byDisplayValue';
+import type { TextMatchOptions } from './byText';
 
 export type GetByAPI = {|
-  getByText: (text: string | RegExp) => ReactTestInstance,
-  getByPlaceholderText: (placeholder: string | RegExp) => ReactTestInstance,
-  getByDisplayValue: (value: string | RegExp) => ReactTestInstance,
-  getByTestId: (testID: string | RegExp) => ReactTestInstance,
-  getAllByTestId: (testID: string | RegExp) => Array<ReactTestInstance>,
-  getAllByText: (text: string | RegExp) => Array<ReactTestInstance>,
+  getByText: (
+    text: string | RegExp,
+    queryOptions?: TextMatchOptions
+  ) => ReactTestInstance,
+  getByPlaceholderText: (
+    placeholder: string | RegExp,
+    queryOptions?: TextMatchOptions
+  ) => ReactTestInstance,
+  getByDisplayValue: (
+    value: string | RegExp,
+    queryOptions?: TextMatchOptions
+  ) => ReactTestInstance,
+  getByTestId: (
+    testID: string | RegExp,
+    queryOptions?: TextMatchOptions
+  ) => ReactTestInstance,
+  getAllByTestId: (
+    testID: string | RegExp,
+    queryOptions?: TextMatchOptions
+  ) => Array<ReactTestInstance>,
+  getAllByText: (
+    text: string | RegExp,
+    queryOptions?: TextMatchOptions
+  ) => Array<ReactTestInstance>,
   getAllByPlaceholderText: (
-    placeholder: string | RegExp
+    placeholder: string | RegExp,
+    queryOptions?: TextMatchOptions
+  ) => Array<ReactTestInstance>,
+  getAllByDisplayValue: (
+    value: string | RegExp,
+    queryOptions?: TextMatchOptions
   ) => Array<ReactTestInstance>,
-  getAllByDisplayValue: (value: string | RegExp) => Array<ReactTestInstance>,
 
   // Unsafe aliases
   UNSAFE_getByType: <P>(type: React.ComponentType<P>) => ReactTestInstance,