update description for onyxData

ashishsah1000 · Jun 24, 2022 · d474717 · d474717
1 parent b3e5f4d
commit d474717
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/src/libs/API.js b/src/libs/API.js
@@ -13,7 +13,9 @@ import {version} from '../../package.json';
  *
  * @param {String} command - Name of API command to call
  * @param {Object} apiCommandParameters - The object of parameters to send to the API
- * @param {Object} onyxData  - Object containing errors, loading states, and optimistic UI data
+ * @param {Object} onyxData  - Object containing errors, loading states, and optimistic UI data that will be merged
+ *                             into Onyx before and after a request is made. Each nested object will be formatted in
+ *                             the same way as an API response.
  * @param {Object} [onyxData.optimisticData] - An object of data that will be merged into Onyx before the request is made
  * @param {Object} [onyxData.successData] - An object of data that will be merged into Onyx when the request succeeds.
  * @param {Object} [onyxData.failureData] - An object of data that will be merged into Onyx when the request fails.