crunchyroll-js-api
Version:
JavaScript API consumer for crunchyroll
166 lines (165 loc) • 4.76 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
* @returns {Promise<Object>}
*/
declare function getEpisode({ account, episodeId }: {
account: import('../types').AccountAuth;
episodeId: string;
}): Promise<any>;
/**
* @param {Object} obj
* @param {import('../types').AccountAuth} obj.account
* @param {String} obj.seasonId
* @returns {Promise<Object>}
*/
declare function getEpisodes({ account, seasonId }: {
account: import('../types').AccountAuth;
seasonId: string;
}): Promise<any>;
/**
* @param {Object} obj
* @param {import('../types').AccountAuth} obj.account
* @param {String} obj.movieId
* @returns {Promise<Object>}
*/
declare function getMovie({ account, movieId }: {
account: import('../types').AccountAuth;
movieId: string;
}): Promise<any>;
/**
* @param {Object} obj
* @param {import('../types').AccountAuth} obj.account
* @param {String} obj.movieListingId
* @returns {Promise<Object>}
*/
declare function getMovieListing({ account, movieListingId }: {
account: import('../types').AccountAuth;
movieListingId: string;
}): Promise<any>;
/**
* @param {Object} obj
* @param {import('../types').AccountAuth} obj.account
* @param {String} obj.movieListingId
* @returns {Promise<Object>}
*/
declare function getMovieListingExtras({ account, movieListingId }: {
account: import('../types').AccountAuth;
movieListingId: string;
}): Promise<any>;
/**
* @param {Object} obj
* @param {import('../types').AccountAuth} obj.account
* @param {String} obj.movieListingId
* @returns {Promise<Object>}
*/
declare function getMovies({ account, movieListingId }: {
account: import('../types').AccountAuth;
movieListingId: string;
}): Promise<any>;
/**
* @param {Object} obj
* @param {import('../types').AccountAuth} obj.account
* @param {Array<String>} obj.objectIds
* @param {Boolean} obj.ratings
* @returns {Promise<{total: Number, data: Array<Object>, meta: Object}>}
*/
declare function getObjects({ account, objectIds, ratings }: {
account: import('../types').AccountAuth;
objectIds: Array<string>;
ratings: boolean;
}): Promise<{
total: number;
data: Array<any>;
meta: any;
}>;
/**
* @param {Object} obj
* @param {import('../types').AccountAuth} obj.account
* @param {String} obj.seasonId
* @returns {Promise<Object>}
*/
declare function getSeason({ account, seasonId }: {
account: import('../types').AccountAuth;
seasonId: string;
}): Promise<any>;
/**
* @param {Object} obj
* @param {import('../types').AccountAuth} obj.account
* @param {String} obj.seasonId
* @returns {Promise<Object>}
*/
declare function getSeasonExtras({ account, seasonId }: {
account: import('../types').AccountAuth;
seasonId: string;
}): Promise<any>;
/**
* @param {Object} obj
* @param {import('../types').AccountAuth} obj.account
* @param {String} obj.serieId
* @returns {Promise<Object>}
*/
declare function getSeasons({ account, serieId }: {
account: import('../types').AccountAuth;
serieId: string;
}): Promise<any>;
/**
* @param {Object} obj
* @param {import('../types').AccountAuth} obj.account
* @param {String} obj.serieId
* @returns {Promise<Object>}
*/
declare function getSeries({ account, serieId }: {
account: import('../types').AccountAuth;
serieId: string;
}): Promise<any>;
/**
* @deprecated
* @param {Object} obj
* @param {import('../types').AccountAuth} obj.account
* @param {String} obj.streamUrl
* @returns {Promise<Object>}
*/
declare function getStreamsWithURL({ account, streamUrl }: {
account: import('../types').AccountAuth;
streamUrl: string;
}): Promise<any>;
/**
* @deprecated
* @param {Object} obj
* @param {import('../types').AccountAuth} obj.account
* @param {String} obj.contentId
* @returns {Promise<Object>}
*/
declare function getStreams({ account, contentId }: {
account: import('../types').AccountAuth;
contentId: string;
}): Promise<any>;
/**
* @param {Object} obj
* @param {import('../types').AccountAuth} obj.account
* @param {String} obj.contentId
* @returns {Promise<Object>}
*/
declare function getSkiptEvents({ account, contentId }: {
account: import('../types').AccountAuth;
contentId: string;
}): Promise<any>;