unimore/pds-2021-g2-nest
unimore/pds-2021-g2-nest
1
Fork 0
mirror of https://github.com/pds-nest/nest.git synced 2024-11-25 14:34:19 +00:00
Code Activity

📔 Document useBackendViewset

Browse source
This commit is contained in:
Steffo 2021-05-19 16:47:29 +02:00
parent b37eda411f
commit fdb3e64dad
Signed by: steffo
GPG key ID: 6965406171929D01
1 changed files with 10 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
nest_frontend/hooks/useBackendViewset.js
View file

@ -4,7 +4,14 @@ import ContextUser from "../contexts/ContextUser"
import makeURLSearchParams from "../utils/makeURLSearchParams"
export default function useBackendViewset(resourcesPath, pkName) {
/**
* An hook which allows access to a full REST viewset (list, create, retrieve, edit, delete).
*
* @param resourcesPath - The path of the resource directory.
* @param pkName - The name of the primary key attribute of the elements.
* @param refreshOnStart - Whether the data should be loaded at the first startup (defaults to true).
*/
export default function useBackendViewset(resourcesPath, pkName, refreshOnStart = true) {
const { server } = useContext(ContextServer)
const configured = server !== null
@ -195,14 +202,12 @@ export default function useBackendViewset(resourcesPath, pkName) {
useEffect(
() => {
if(!(
loaded || running
)) {
if(refreshOnStart && !(loaded || running)) {
// noinspection JSIgnoredPromiseFromCall
refreshResources()
}
},
[loaded, refreshResources, running],
[loaded, refreshResources, running, refreshOnStart],
)
return {