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

Web3 shh typings #2128

Merged
merged 10 commits into from
Dec 17, 2018
+750 −32
Merged

Web3 shh typings #2128

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
99f232c
web3-shh package.json for types
joshstevens19 Dec 15, 2018
2dde705
web3-shh package-lock.json
joshstevens19 Dec 15, 2018
a7d8633
web3-shh typings
joshstevens19 Dec 15, 2018
d732742
web3-shh typings tests
joshstevens19 Dec 15, 2018
f6663ee
web3-shh tsconfig
joshstevens19 Dec 15, 2018
10bb65c
web3-shh tslint.json
joshstevens19 Dec 15, 2018
c1fc4cd
update incorrect docs for web3-shh
joshstevens19 Dec 15, 2018
daaf9c7
`getFilterMessages` returns a array no object
joshstevens19 Dec 15, 2018
8b295ba
remove the `update docs` reminder
joshstevens19 Dec 15, 2018
53adab1
make sure `shh-test.ts` is the correct @file
joshstevens19 Dec 15, 2018
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
42 changes: 21 additions & 21 deletions docs/web3-shh.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ Returns
-------


``String`` - The version of the current whisper running.
``Promise`` returns ``String`` - The version of the current whisper running.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would like this syntax more: Promise<String> 🤔

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would as well but the web3-eth describes it like this so i wanted to keep it consistent

https://web3js.readthedocs.io/en/1.0/web3-eth.html#getcoinbase

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay then I'll change that later everywhere :)



-------
Expand Down Expand Up @@ -103,7 +103,7 @@ Returns
-------


``Object`` - The information of the node with the following properties:
``Promise`` returns ``Object`` - The information of the node with the following properties:

- ``messages`` - ``Number``: Number of currently floating messages.
- ``maxMessageSize`` - ``Number``: The current message size limit in bytes.
Expand Down Expand Up @@ -153,7 +153,7 @@ Returns
-------


``Boolean`` - ``true`` on success, error on failure.
``Promise`` returns ``Boolean`` - ``true`` on success, error on failure.


-------
Expand Down Expand Up @@ -196,7 +196,7 @@ Returns
-------


``Boolean`` - ``true`` on success, error on failure.
``Promise`` returns ``Boolean`` - ``true`` on success, error on failure.


-------
Expand Down Expand Up @@ -237,7 +237,7 @@ Returns
-------


``Boolean`` - ``true`` on success, error on failure.
``Promise`` returns ``Boolean`` - ``true`` on success, error on failure.


-------
Expand Down Expand Up @@ -275,7 +275,7 @@ Returns
-------


``String`` - Key ID on success and an error on failure.
``Promise`` returns ``String`` - Key ID on success and an error on failure.


-------
Expand Down Expand Up @@ -314,7 +314,7 @@ Returns
-------


``String`` - Key ID on success and an error on failure.
``Promise`` returns ``String`` - Key ID on success and an error on failure.


-------
Expand Down Expand Up @@ -353,7 +353,7 @@ Returns
-------


``Boolean`` - ``true`` on success, error on failure.
``Promise`` returns ``Boolean`` - ``true`` on success, error on failure.


-------
Expand Down Expand Up @@ -392,7 +392,7 @@ Returns
-------


``Boolean`` - ``true`` on if the key pair exist in the node, ``false`` if not. Error on failure.
``Promise`` returns ``Boolean`` - ``true`` on if the key pair exist in the node, ``false`` if not. Error on failure.


-------
Expand Down Expand Up @@ -431,7 +431,7 @@ Returns
-------


``String`` - Public key on success and an error on failure.
``Promise`` returns ``String`` - Public key on success and an error on failure.


-------
Expand Down Expand Up @@ -470,7 +470,7 @@ Returns
-------


``String`` - Private key on success and an error on failure.
``Promise`` returns ``String`` - Private key on success and an error on failure.


-------
Expand Down Expand Up @@ -509,7 +509,7 @@ Returns
-------


``String`` - Key ID on success and an error on failure.
``Promise`` returns ``String`` - Key ID on success and an error on failure.


-------
Expand Down Expand Up @@ -548,7 +548,7 @@ Returns
-------


``String`` - Key ID on success and an error on failure.
``Promise`` returns ``String`` - Key ID on success and an error on failure.


-------
Expand Down Expand Up @@ -587,7 +587,7 @@ Returns
-------


``String`` - Key ID on success and an error on failure.
``Promise`` returns ``String`` - Key ID on success and an error on failure.


-------
Expand Down Expand Up @@ -626,7 +626,7 @@ Returns
-------


``Boolean`` - ``true`` on if the symmetric key exist in the node, ``false`` if not. Error on failure.
``Promise`` returns ``Boolean`` - ``true`` on if the symmetric key exist in the node, ``false`` if not. Error on failure.


-------
Expand Down Expand Up @@ -665,7 +665,7 @@ Returns
-------


``String`` - The raw symmetric key on success and an error on failure.
``Promise`` returns ``String`` - The raw symmetric key on success and an error on failure.


-------
Expand Down Expand Up @@ -704,7 +704,7 @@ Returns
-------


``Boolean`` - ``true`` on if the symmetric key was deleted, error on failure.
``Promise`` returns ``Boolean`` - ``true`` on if the symmetric key was deleted, error on failure.


-------
Expand Down Expand Up @@ -753,7 +753,7 @@ Parameters
Returns
-------

``Promise`` - returns a promise. Upon success, the ``then`` function will be passed a string representing the hash of the sent message. On error, the ``catch`` function will be passed a string containing the reason for the error.
``Promise`` returns ``Promise`` - returns a promise. Upon success, the ``then`` function will be passed a string representing the hash of the sent message. On error, the ``catch`` function will be passed a string containing the reason for the error.


-------
Expand Down Expand Up @@ -934,7 +934,7 @@ Parameters
Returns
-------

``String``: The filter ID.
``Promise`` returns ``String``: The filter ID.

-------
Example
Expand Down Expand Up @@ -968,7 +968,7 @@ Parameters
Returns
-------

``Boolean``: ``true`` on success, error on failure.
``Promise`` returns ``Boolean``: ``true`` on success, error on failure.

-------
Example
Expand Down Expand Up @@ -1003,7 +1003,7 @@ Parameters
Returns
-------

``Array``: Returns an array of message objects like :ref:`web3.shh.subscribe() notification returns <shh-subscribenotificationreturns>`
``Promise`` returns ``Array``: Returns an array of message objects like :ref:`web3.shh.subscribe() notification returns <shh-subscribenotificationreturns>`

-------
Example
Expand Down
Loading