https://github.com/xusoo/tmdb-typescript-api
TMDB's API Wrapper made with Typescript and RxJS
https://github.com/xusoo/tmdb-typescript-api
api api-wrapper observables rxjs tmdb typescript
Last synced: 4 months ago
JSON representation
TMDB's API Wrapper made with Typescript and RxJS
- Host: GitHub
- URL: https://github.com/xusoo/tmdb-typescript-api
- Owner: xusoo
- License: mit
- Created: 2017-09-03T17:03:10.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2018-10-12T17:50:36.000Z (over 6 years ago)
- Last Synced: 2025-01-16T09:48:02.713Z (5 months ago)
- Topics: api, api-wrapper, observables, rxjs, tmdb, typescript
- Language: TypeScript
- Size: 192 KB
- Stars: 28
- Watchers: 2
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
This project is a wrapper of the TMDB's v3 API, made with Typescript and RxJS.
## Installation
`npm install --save tmdb-typescript-api`
## Features
Implemented features so far are:
- Search
- Movies
- Shows
- People
- Collections
- Companies
- Keywords
- Movies
- Details
- TV
- Details
- People
- Details
- Collections
- Details
(PR are welcome, complete list: https://developers.themoviedb.org/3/)
## Usage
```typescript
let api: TmdbApi = new TmdbApi('');
api.search.movies('Pulp Fiction').subscribe(movies => {
let movie = movies.results[0];
console.log(`"Pulp Fiction" was released in ${movie.release_date}`);
});
api.tvshows.details(4607).subscribe(show => {
console.log(`"Lost" had ${show.number_of_seasons} seasons`);
});
```
Every resultant object is an exact copy of the JSON obtained from the original API, so for further documentation: https://developers.themoviedb.org/3/getting-started
## Test
`npm run test`
This will trigger an offline testing using mock JSON fixtures. If you want to try calls against the actual API, you just need to pass the API key as well:
`npm run test -- --api-key=`
(You also can use `karma start`)
## Build
`npm run build`
(Or `rollup -c`)