585763750e
Summary: The implementation of react-native-flipper [makes runtime assertions](https://github.com/facebook/flipper/blob/main/react-native/react-native-flipper/index.js#L20) about some variables but those type requirements [aren't properly reflected in the Typescript type defs](https://github.com/facebook/flipper/blob/main/react-native/react-native-flipper/index.d.ts#L45). ## Changelog Corrected Typescript type defs in react-native-flipper Pull Request resolved: https://github.com/facebook/flipper/pull/3209 Test Plan: (No runtime effect) In vscode, the typings now properly restrict the arguments to `FlipperResponder.success`, `FlipperResponder.error`, and `FlipperConnection.send` Reviewed By: antonk52 Differential Revision: D33307792 Pulled By: mweststrate fbshipit-source-id: da3bf7fcacdf3718dc9a625e4229f3c8ecd7ac93
react-native-flipper
This package exposes JavaScript bindings to talk from React Native JavaScript directly to flipper.
This package might also be required by other Flipper plugins for React Native.
Installation
Run the following command in the root of your React Native project
yarn add react-native-flipper
Note that this package requires React Native 0.62 or higher.
Usage
How to build Flipper plugins is explained in the flipper documentation: Creating a Flipper plugin. Building a Flipper plugin involves building a plugin for the Desktop app, and a plugin that runs on a Device (Native Android, Native IOS or React Native). This package is only needed for the plugin that runs on the mobile device, in React Native, and wants to use the JavaScript bridge.
This package exposes one method: addPlugin.
The addPlugin accepts a plugin parameter, that registers a client plugin and will fire the relevant callbacks if the corresponding desktop plugin is selected in the Flipper Desktop. The full plugin API is documented here.
Example
An example plugin can be found in FlipperTicTacToe.js.
The corresponding Desktop plugin ships by default in Flipper, so importing the above file and dropping the <FlipperTicTacToe /> component somewhere in your application should work out of the box.
The sources of the corresponding Desktop plugin can be found here.