Add API reference. Update Onyx docs to explain current merge() behavior. #106
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Luke9389
reviewed
Oct 26, 2021
mountiny
previously approved these changes
Oct 27, 2021
Jag96
reviewed
Oct 27, 2021
README.md
Outdated
|
|
||
| ## Initialization | ||
|
|
||
| To initialize Onyx we call `Onyx.init()` with a configuration object like so |
There was a problem hiding this comment.
Suggested change
| To initialize Onyx we call `Onyx.init()` with a configuration object like so | |
| To initialize Onyx we call `Onyx.init()` with a configuration object. |
README.md
Outdated
| @@ -65,7 +195,7 @@ If you wish to reset the metrics and start over use `Onyx.resetMetrics()` | |||
| Finally, there's a `Onyx.printMetrics()` method which prints human statistics information on the dev console | |||
There was a problem hiding this comment.
Add a . here, or combine w/ `You can use this method during debugging.
README.md
Outdated
| @@ -65,7 +195,7 @@ If you wish to reset the metrics and start over use `Onyx.resetMetrics()` | |||
| Finally, there's a `Onyx.printMetrics()` method which prints human statistics information on the dev console | |||
| You can use this method during debugging. For example add an `Onyx.printMetrics()` line somewhere in code or call it | |||
| through the dev console. It supports 3 popular formats *MD* - human friendly markdown, *CSV* and *JSON* | |||
| The default is MD if you want to print another format call `Onyx.printMetrics({ format: 'csv' })` or | |||
| The default is MD if you want to print another format call `Onyx.printMetrics({ format: 'csv' })` or | |||
There was a problem hiding this comment.
Add a . before this sentence
lib/Onyx.js
Outdated
| * This is used by React components to connect to Onyx | ||
| * @param {object} [mapping.callback] a method that will be called with changed data | ||
| * @param {Object} [mapping.callback] a method that will be called with changed data |
Jag96
approved these changes
Oct 27, 2021
yuwenmemon
approved these changes
Oct 27, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Details
merge()behavior for objects and arrays is a potential point of confusion.npm run build-docsscript that will automatically generate anAPI.mdwith all public methods that Onyx has.Related Issues
#83
Automated Tests
❌
Linked PRs
❌