node-csfd-api/dto/user-ratings.d.cts

ČSFD API in JavaScript. Amazing NPM library for scrapping csfd.cz :)

import { CSFDFilmTypes, CSFDScreening, CSFDStars } from "./global.cjs";

//#region src/dto/user-ratings.d.ts
interface CSFDUserRatings extends CSFDScreening {
  userRating: CSFDStars;
  userDate: string;
}
interface CSFDUserRatingConfig {
  includesOnly?: CSFDFilmTypes[];
  excludes?: CSFDFilmTypes[];
  /**
   * Fetch all ratings. (Warning: Use it wisely. Can be detected and banned. Consider using it together with `allPagesDelay` attribute)
   */
  allPages?: boolean;
  /**
   * Delay on each page request. In milliseconds
   */
  allPagesDelay?: number;
  /**
   * Specific page number to fetch (e.g., 2 for second page)
   */
  page?: number;
  /**
   * Called on each page fetch when `allPages` is enabled.
   * Useful for rendering progress in CLI tools or custom logging.
   * @param page - Current page number
   * @param total - Total number of pages
   */
  onProgress?: (page: number, total: number) => void;
}
type CSFDColors = 'lightgrey' | 'blue' | 'red' | 'grey';
//#endregion
export { CSFDColors, CSFDUserRatingConfig, CSFDUserRatings };
//# sourceMappingURL=user-ratings.d.cts.map