@octoguide/firebase-utils
v1.1.35
Published
<dl> <dt><a href="#fetchDataRequest">fetchDataRequest</a></dt> <dd><p>fetch data with or without any path parameters</p> </dd> <dt><a href="#fetchUriDataRequest">fetchUriDataRequest</a></dt> <dd><p>fetch data using the uri provided</p> </dd> <dt><a href="
Downloads
40
Readme
Constants
fetchDataRequest
fetch data with or without any path parameters
Kind: global constant
| Param | Type | Description | | --- | --- | --- | | endpointLookup | string | correspond with ApiConfig service endpoints | | pathParams | Array | array of known pathParams - i.e. ['orgId'] or null if none | | pathParamValues | Array | array of corresponding pathParamValues or null if none | | config | Array | array of config entries passed in from the target app |
fetchUriDataRequest
fetch data using the uri provided
Kind: global constant
| Param | Type | Description | | --- | --- | --- | | uri | string | the uri to use in the get request |
addOrUpdateDataRequest
Update the payload object and make the call to the API - return the payload updated (may contain an id if a new object)
Kind: global constant
| Param | Type | Description | | --- | --- | --- | | currentList | Array | current list that is going to be changed - DEPRECATED PARAMETER (May 2020) | | payload | Object | the payload being updated/ added | | postEndpoint | string | the add endpoint - key links to ApiConfig | | putEndpoint | string | the update endpoint - key links to ApiConfig | | pathParams | Array | array of known pathParams - i.e. ['orgId'] or null if none | | pathParamValues | Array | array of corresponding pathParamValues - i.e. [orgId] or null if none | | config | Array | array of config entries passed in from the target app |