Skip to content

Commit 3eb3383

Browse files
committed
Add more JSDoc
1 parent e7da6f3 commit 3eb3383

File tree

2 files changed

+12
-0
lines changed

2 files changed

+12
-0
lines changed

src/Chain.js

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,14 @@
1515
* along with this program. If not, see <http://www.gnu.org/licenses/>.
1616
*/
1717

18+
/**
19+
* A chain holds the state of the sub ratchet, used for sending multiple messages before receiving a reply.
20+
*/
1821
export default class Chain {
22+
/**
23+
*
24+
* @param {ArrayBuffer} key
25+
*/
1926
constructor(key) {
2027
this.key = key;
2128
this.index = 0;

src/PromiseInterfaceDecorator.js

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,11 @@ var wrap = (fn) => {
2121
};
2222
};
2323

24+
/**
25+
* Wraps an instance of a concrete class converting all methods to return promises.
26+
* <p>
27+
* This allows the consumer to deal only with promises.
28+
*/
2429
export default class PromiseInterfaceDecorator {
2530
constructor(impl, methodNames) {
2631
methodNames.forEach((methodName) => {

0 commit comments

Comments
 (0)