Skip to content

Commit

Permalink
update apiCommandParameters description
Browse files Browse the repository at this point in the history
  • Loading branch information
marcochavezf committed Jun 24, 2022
1 parent 515933b commit 2ca5f98
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions src/libs/API.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import {version} from '../../package.json';
* This is so that if the network is unavailable or the app is closed, we can send the WRITE request later.
*
* @param {String} command - Name of API command to call.
* @param {Object} apiCommandParameters - The object of parameters to send to the API.
* @param {Object} apiCommandParameters - Parameters to send to the API.
* @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.
Expand Down Expand Up @@ -55,7 +55,7 @@ function write(command, apiCommandParameters = {}, onyxData = {}) {
* It is best to discuss it in Slack anytime you are tempted to use this method.
*
* @param {String} command - Name of API command to call.
* @param {Object} apiCommandParameters - The object of parameters to send to the API.
* @param {Object} apiCommandParameters - Parameters to send to the API.
* @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.
Expand Down Expand Up @@ -91,7 +91,7 @@ function makeRequestWithSideEffects(command, apiCommandParameters = {}, onyxData
* Requests made with this method are not be persisted to disk. If there is no network connectivity, the request is ignored and discarded.
*
* @param {String} command - Name of API command to call.
* @param {Object} apiCommandParameters - The object of parameters to send to the API.
* @param {Object} apiCommandParameters - Parameters to send to the API.
* @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.
Expand Down

0 comments on commit 2ca5f98

Please sign in to comment.