Function useResource

react/src/hooks.ts:24–73

(
  subject: string,
  opts: {
    /**
     * If this is true, incomplete resources will not be automatically fetched.
     * This limits the amount of requests. Use this for things like menu items.
     */
    allowIncomplete?: boolean;
    /**
     * Set to true if you are initializing a new resource. The resource will not
     * be fetched.
     */
    newResource?: boolean;
  } = { allowIncomplete: false, newResource: false },
)

 * subject and add its parsed values to the store.
 */
export function useResource(
  subject: string,
  opts: {
    /**
     * If this is true, incomplete resources will not be automatically fetched.
     * This limits the amount of requests. Use this for things like menu items.
     */
    allowIncomplete?: boolean;
    /**
     * Set to true if you are initializing a new resource. The resource will not
     * be fetched.
     */
    newResource?: boolean;
  } = { allowIncomplete: false, newResource: false },
): Resource {
  const { newResource, allowIncomplete } = opts;
  const store = useStore();
  const [resource, setResource] = useState<Resource>(
    store.getResourceLoading(subject, {
      newResource,
      allowIncomplete,
    }),
  );

  // If the subject changes, make sure to change the resource!
  useEffect(() => {
    setResource(
      store.getResourceLoading(subject, {
        newResource,
        allowIncomplete,
      }),
    );
  }, [subject, store]);

  // When a component mounts, it needs to let the store know that it will subscribe to changes to that resource.
  useEffect(() => {
    function handleNotify(updated: Resource) {
      // When a change happens, set the new Resource.
      setResource(updated);
    }
    subject && store.subscribe(subject, handleNotify);

    return () => {
      // When the component is unmounted, unsubscribe from the store.
      store.unsubscribe(subject, handleNotify);
    };
  }, [store, subject]);

  return resource;
}

/**
 * Converts an array of Atomic URL strings to an array of Resources. Could take