fluencelabs/js-libp2p
1
0
Fork 0
mirror of https://github.com/fluencelabs/js-libp2p synced 2025-04-25 18:42:15 +00:00
Code Issues Projects Releases Wiki Activity

docs: add DialRequest description

Browse Source
This commit is contained in:
Jacob Heun 2019-12-06 18:43:59 +01:00
parent 962081f448
commit 43b98e64b6
No known key found for this signature in database
GPG Key ID: CA5A94C15809879F
1 changed files with 5 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
src/dialer/dial-request.js
View File

@ -11,7 +11,11 @@ const pAny = require('p-any')
class DialRequest { class DialRequest {
/** /**
* * Manages running the `dialAction` on multiple provided `addrs` in parallel
* up to a maximum determined by the number of tokens returned
* from `dialer.getTokens`. Once a DialRequest is created, it can be
* started using `DialRequest.run(options)`. Once a single dial has succeeded,
* all other dials in the request will be cancelled.
* @param {object} options * @param {object} options
* @param {Multiaddr[]} options.addrs * @param {Multiaddr[]} options.addrs
* @param {function(Multiaddr):Promise<Connection>} options.dialAction * @param {function(Multiaddr):Promise<Connection>} options.dialAction