caccl-api
Version:
A class that defines a set of smart Canvas endpoints that actually behave how you'd expect them to.
21 lines (20 loc) • 537 B
TypeScript
/**
* Configuration for endpoint call
* @author Gabe Abrams
*/
type APIConfig = {
canvasHost?: string;
accessToken?: string;
numRetries?: number;
itemsPerPage?: number;
maxPages?: number;
/**
* Handler to call when a new page of data returns from Canvas
* @param page data in the new page
* @param pageNumber number of the page (starting at 1)
*/
onNewPage?: (page: any, pageNumber: number) => void;
authenticityToken?: string;
pathPrefix?: string;
};
export default APIConfig;