@selfcommunity/react-core
Version:
React Core Components useful for integrating UI Community components (react-ui).
25 lines (24 loc) • 698 B
TypeScript
import { CourseInfoParams } from '@selfcommunity/api-services';
import { SCCourseType } from '@selfcommunity/types';
import { CacheStrategies } from '@selfcommunity/utils';
/**
:::info
This custom hook is used to fetch a course object.
:::
* @param object
* @param object.id
* @param object.course
* @param object.cacheStrategy
* @param object.params
*/
export default function useSCFetchCourse({ id, course, cacheStrategy, params, }: {
id?: number | string;
course?: SCCourseType;
cacheStrategy?: CacheStrategies;
params?: CourseInfoParams;
}): {
scCourse: SCCourseType;
setSCCourse: (c: SCCourseType) => void;
error: string;
refreshCourse: () => void;
};