Skip to content

Commit

Permalink
Expand on debugging methods (realm#4229)
Browse files Browse the repository at this point in the history
  • Loading branch information
@takameyer
takameyer authored Jan 18, 2022
1 parent e48b9df commit 2ebc475
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 5 deletions.
11 changes: 7 additions & 4 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 52,13 @@ npx react-native init JsExample --template @realm/react-native-template-js
* **Have a bug to report?** [Open an issue](https://github.com/realm/realm-js/issues/new). If possible, include the version of Realm, a full log, the Realm file, and a project that shows the issue.
* **Have a feature request?** [Open an issue](https://github.com/realm/realm-js/issues/new). Tell us what the feature should do, and why you want the feature.

## Known issues

* Realm is not compatible with the Chrome Debugger. The following debugging methods are supported.
* [Flipper](https://fbflipper.com/) has many similar features in relation to the Chrome Debugger. Please consider trying out our [Hermes release](https://github.com/realm/realm-js/issues/3940) to use the Hermes Debugger in Flipper and set breakpoints in your code.
* [Safari](https://reactnative.dev/docs/debugging#safari-developer-tools) also has a similar feature set, but requires [some setup](https://blog.nparashuram.com/2019/10/debugging-react-native-ios-apps-with.html) and only supports debugging in iOS.
* **NOTE:** For the above methods, it is not neccessary to enable `Debug with Chrome` in the Debug Menu.

## Building Realm JS

For instructions on building Realm JS yourself from source, see the [building.md](contrib/building.md) file.
Expand Down Expand Up @@ -87,10 94,6 @@ Currently the following information is reported:
* Node.js, v8, libuv, OpenSSL version numbers.
* An anonymous machine identifier and hashed application path to aggregate the other information on.

## Known issues

* The Chrome Debugger does not support `Realm.Set`, `Realm.Dictionary`, `Realm.Mixed` and `Realm.UUID`. Please consider trying out our [Hermes releases](https://github.com/realm/realm-js/issues/3940) and using [Flipper](https://fbflipper.com/) as debugger.

## Code of Conduct

This project adheres to the [MongoDB Code of Conduct](https://www.mongodb.com/community-code-of-conduct).
Expand Down
2 changes: 1 addition & 1 deletion vendor/realm-core
Submodule realm-core updated 152 files

0 comments on commit 2ebc475

Please sign in to comment.