Skip to content

Commit

Permalink
docs(api): remove hoodie.ready (#769)
Browse files Browse the repository at this point in the history
  • Loading branch information
kahlil authored and gr2m committed Jun 6, 2017
1 parent 64bb2ee commit 4dcf9cb
Showing 1 changed file with 0 additions and 23 deletions.
23 changes: 0 additions & 23 deletions docs/api/client/hoodie.rst
Original file line number Diff line number Diff line change
Expand Up @@ -78,29 +78,6 @@ Constructor
| | | to ``HEAD`` | |
+------------------------------+----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------+


hoodie.ready
------------

`Read-only`

.. code:: js
hoodie.ready
Promise that resolves once the hoodie API is fully initialised.

Things like the the username or session ID are persisted in the local store and have to be loaded before APIs like ``hoodie.account.id`` can be used.
It’s therefore necessary to wait until the hoodie API is ready before using it.

.. code:: js
hoodie.ready.then(function () {
if (hoodie.account.isSignedIn()) {
alert('Welcome, ' + hoodie.account.username)
}
})
hoodie.url
----------

Expand Down

0 comments on commit 4dcf9cb

Please sign in to comment.