Skip to content

Commit

Permalink
docs: document API
Browse files Browse the repository at this point in the history
  • Loading branch information
gajus committed Sep 17, 2017
1 parent 2dc3d08 commit 09134ea
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,14 @@ const tmdb = new Tmdb(apiKey);

```

### API

Refer to the [source code](./src/Tmdb.js) and the [type definitions](./src/types.js).

> Note: Only a subset of the API is implemented. I will be adding new methods as needed.
> If you need a method added, raise a PR. Alternatively, you can use the low-level `get`
> method to construct any API calls.
### Handling errors

Methods that are expected to return a specific resource will throw `NotFoundError` if the resource is not found.
Expand Down

0 comments on commit 09134ea

Please sign in to comment.