Skip to content

Adding description of errors to README.md #272

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
alonisser wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Adding description of errors to README.md #272

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -173,6 +173,21 @@ const isTweet = _.conforms({
})
```

## API errors

Api errors are returned (with "catch" in the Promise api or with "err" param in the callback api) as an array of errors.
Thus errors described in twitter docs for example as:
```JSON
{ "errors": [ { "code": 88, "message": "Rate limit exceeded" } ] }

```
Would return as :

```
[ { "code": 88, "message": "Rate limit exceeded" } ]

```

## Examples

* [Tweet](https://github.com/desmondmorris/node-twitter/tree/master/examples#tweet)
Expand Down