crunchyroll-js-api
Version:
JavaScript API consumer for crunchyroll
194 lines (193 loc) • 6.64 kB
TypeScript
declare namespace _default {
export { getEpisode };
export { getEpisodes };
export { getMovie };
export { getMovieListing };
export { getMovieListingExtras };
export { getMovies };
export { getObjects };
export { getSeason };
export { getSeasonExtras };
export { getSeasons };
export { getSeries };
export { getStreamsWithURL };
export { getStreams };
export { getSkiptEvents };
}
export default _default;
/**
* @param {Object} obj
* @param {import('../types').AccountAuth} obj.account
* @param {String} obj.episodeId
* @param {import('../types').FetchConfig} [obj.fnConfig] util config param
* @returns {Promise<Object>}
*/
declare function getEpisode({ account, episodeId, fnConfig }: {
account: import("../types").AccountAuth;
episodeId: string;
fnConfig?: import("../types").FetchConfig;
}): Promise<any>;
/**
* @param {Object} obj
* @param {import('../types').AccountAuth} obj.account
* @param {String} obj.seasonId
* @param {import('../types').FetchConfig} [obj.fnConfig] util config param
* @returns {Promise<Object>}
*/
declare function getEpisodes({ account, seasonId, fnConfig }: {
account: import("../types").AccountAuth;
seasonId: string;
fnConfig?: import("../types").FetchConfig;
}): Promise<any>;
/**
* @param {Object} obj
* @param {import('../types').AccountAuth} obj.account
* @param {String} obj.movieId
* @param {import('../types').FetchConfig} [obj.fnConfig] util config param
* @returns {Promise<Object>}
*/
declare function getMovie({ account, movieId, fnConfig }: {
account: import("../types").AccountAuth;
movieId: string;
fnConfig?: import("../types").FetchConfig;
}): Promise<any>;
/**
* @param {Object} obj
* @param {import('../types').AccountAuth} obj.account
* @param {String} obj.movieListingId
* @param {import('../types').FetchConfig} [obj.fnConfig] util config param
* @returns {Promise<Object>}
*/
declare function getMovieListing({ account, movieListingId, fnConfig }: {
account: import("../types").AccountAuth;
movieListingId: string;
fnConfig?: import("../types").FetchConfig;
}): Promise<any>;
/**
* @param {Object} obj
* @param {import('../types').AccountAuth} obj.account
* @param {String} obj.movieListingId
* @param {import('../types').FetchConfig} [obj.fnConfig] util config param
* @returns {Promise<Object>}
*/
declare function getMovieListingExtras({ account, movieListingId, fnConfig }: {
account: import("../types").AccountAuth;
movieListingId: string;
fnConfig?: import("../types").FetchConfig;
}): Promise<any>;
/**
* @param {Object} obj
* @param {import('../types').AccountAuth} obj.account
* @param {String} obj.movieListingId
* @param {import('../types').FetchConfig} [obj.fnConfig] util config param
* @returns {Promise<Object>}
*/
declare function getMovies({ account, movieListingId, fnConfig }: {
account: import("../types").AccountAuth;
movieListingId: string;
fnConfig?: import("../types").FetchConfig;
}): Promise<any>;
/**
* @param {Object} obj
* @param {import('../types').AccountAuth} obj.account
* @param {Array<String>} obj.objectIds
* @param {Boolean} obj.ratings
* @param {import('../types').FetchConfig} [obj.fnConfig] util config param
* @returns {Promise<{total: Number, data: Array<Object>, meta: Object}>}
*/
declare function getObjects({ account, objectIds, ratings, fnConfig }: {
account: import("../types").AccountAuth;
objectIds: Array<string>;
ratings: boolean;
fnConfig?: import("../types").FetchConfig;
}): Promise<{
total: number;
data: Array<any>;
meta: any;
}>;
/**
* @param {Object} obj
* @param {import('../types').AccountAuth} obj.account
* @param {String} obj.seasonId
* @param {import('../types').FetchConfig} [obj.fnConfig] util config param
* @returns {Promise<Object>}
*/
declare function getSeason({ account, seasonId, fnConfig }: {
account: import("../types").AccountAuth;
seasonId: string;
fnConfig?: import("../types").FetchConfig;
}): Promise<any>;
/**
* @param {Object} obj
* @param {import('../types').AccountAuth} obj.account
* @param {String} obj.seasonId
* @param {import('../types').FetchConfig} [obj.fnConfig] util config param
* @returns {Promise<Object>}
*/
declare function getSeasonExtras({ account, seasonId, fnConfig }: {
account: import("../types").AccountAuth;
seasonId: string;
fnConfig?: import("../types").FetchConfig;
}): Promise<any>;
/**
* @param {Object} obj
* @param {import('../types').AccountAuth} obj.account
* @param {String} obj.serieId
* @param {import('../types').FetchConfig} [obj.fnConfig] util config param
* @returns {Promise<Object>}
*/
declare function getSeasons({ account, serieId, fnConfig }: {
account: import("../types").AccountAuth;
serieId: string;
fnConfig?: import("../types").FetchConfig;
}): Promise<any>;
/**
* @param {Object} obj
* @param {import('../types').AccountAuth} obj.account
* @param {String} obj.serieId
* @param {import('../types').FetchConfig} [obj.fnConfig] util config param
* @returns {Promise<Object>}
*/
declare function getSeries({ account, serieId, fnConfig }: {
account: import("../types").AccountAuth;
serieId: string;
fnConfig?: import("../types").FetchConfig;
}): Promise<any>;
/**
* @deprecated
* @param {Object} obj
* @param {import('../types').AccountAuth} obj.account
* @param {String} obj.streamUrl
* @param {import('../types').FetchConfig} [obj.fnConfig] util config param
* @returns {Promise<Object>}
*/
declare function getStreamsWithURL({ account, streamUrl, fnConfig }: {
account: import("../types").AccountAuth;
streamUrl: string;
fnConfig?: import("../types").FetchConfig;
}): Promise<any>;
/**
* @deprecated
* @param {Object} obj
* @param {import('../types').AccountAuth} obj.account
* @param {String} obj.contentId
* @param {import('../types').FetchConfig} [obj.fnConfig] util config param
* @returns {Promise<Object>}
*/
declare function getStreams({ account, contentId, fnConfig }: {
account: import("../types").AccountAuth;
contentId: string;
fnConfig?: import("../types").FetchConfig;
}): Promise<any>;
/**
* @param {Object} obj
* @param {import('../types').AccountAuth} obj.account
* @param {String} obj.contentId
* @param {import('../types').FetchConfig} [obj.fnConfig] util config param
* @returns {Promise<Object>}
*/
declare function getSkiptEvents({ account, contentId, fnConfig }: {
account: import("../types").AccountAuth;
contentId: string;
fnConfig?: import("../types").FetchConfig;
}): Promise<any>;