Skip to content

Update README to include example of async function usage with key(). #25

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
KevinGrandon wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update README to include example of async function usage with key(). #25

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
20 changes: 20 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,26 @@ fireproof.auth('my_auth_token').then(function() {
})
```

### Async Functions

This library returns promises and will work well with async functions.

```javascript
// Pushing a record using an async function
var ref = fireproof.child('myref')
var pushref = ref.push({ /* some object */ })

// This is the key of the newly pushed location.
// Note that it is called on the result of ref.push, and not the result of an async function.
console.log(pushref.key())

var error = await pushref
if (error) {
console.error('Something went wrong pushing ' + pushref.key())
console.error(error)
}
```

## Support

IE back to 9.
Expand Down