Skip to content

Document client.ready() #1

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

Document client.ready() #1

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
3 changes: 3 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,9 @@ Check out the [daemon tests](https://github.com/andrewosh/hyperdrive-daemon/blob
### Hyperdrive
The client's Hyperdrive API is designed to mirror the methods in Hyperdrive as closely as possible.

##### `await client.ready([cb])`
Returns a promise which resolves when the client is ready to use. Can accept a callback to use instead of the returned promise.

#### Session Operations

##### `const { info, id } = await client.drive.get(opts)`
Expand Down