Skip to content
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

Remove returnPromises mention from README #188

Merged
merged 1 commit into from
Aug 28, 2023
Merged

Remove returnPromises mention from README #188

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: 2 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,19 +58,8 @@ const client = new tumblr.Client({
});
```

The request methods return `Request` objects by default, but you can have it return `Promise`
objects instead, if that's more your thing. Pass `returnPromises: true` in the options to
`createClient`:

```js
const tumblr = require('tumblr.js');
const client = tumblr.createClient({
credentials: {
// ...
},
returnPromises: true,
});
```
The request methods will return promises. The callback form is considered deprecated and should not
be used.

### In the Browser

Expand Down