@odyssoft/tmdb
Version:
Unofficial TMDB v3 api wrapper, built using TypeScript and node.js
55 lines (54 loc) • 1.9 kB
TypeScript
import * as Types from './types';
declare const Search: (apiKey: string) => {
/**
* Search for companies.
* @param {string} query
* @param {object} options
* @returns Promise<SearchCompanyResponse>
*/
Companies: (options: Types.SearchNoLangOptions) => Promise<Types.SearchCompanyResponse>;
/**
* Search for collections.
* @param {string} query
* @param {object} options
* @returns Promise<SearchCollectionResponse>
*/
Collections: (options: Types.SearchOptions) => Promise<Types.SearchCollectionResponse>;
/**
* Search for keywords.
* @param {string} query
* @param {object} options
* @returns Promise<SearchKeywordResponse>
*/
Keywords: (options: Types.SearchNoLangOptions) => Promise<Types.SearchKeywordResponse>;
/**
* Search for movies.
* @param {string} query
* @param {object} options
* @returns Promise<SearchMovieResponse>
*/
Movies: (options: Types.SearchMainOptions) => Promise<Types.SearchMovieResponse>;
/**
* Search multiple models in a single request.
* Multi search currently supports searching for movies, tv shows and people in a single request.
* @param {string} query
* @param {object} options
* @returns Promise<SearchMultiResponse>
*/
Multi: (options: Types.SearchMainOptions) => Promise<Types.SearchMultiResponse>;
/**
* Search for people.
* @param {string} query
* @param {object} options
* @returns Promise<SearchPersonResponse>
*/
People: (options: Types.SearchMainOptions) => Promise<Types.SearchPersonResponse>;
/**
* Search for a TV show.
* @param {string} query
* @param {object} options
* @returns Promise<SearchTVResponse>
*/
TVShows: (options: Types.SearchMainOptions) => Promise<Types.SearchTVResponse>;
};
export default Search;