From 43b98e64b6786ad7f5d5b9316fcb345840f76369 Mon Sep 17 00:00:00 2001
From: Jacob Heun <jacobheun@gmail.com>
Date: Fri, 6 Dec 2019 18:43:59 +0100
Subject: [PATCH] docs: add DialRequest description

---
 src/dialer/dial-request.js | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/src/dialer/dial-request.js b/src/dialer/dial-request.js
index d297257b..7063de1a 100644
--- a/src/dialer/dial-request.js
+++ b/src/dialer/dial-request.js
@@ -11,7 +11,11 @@ const pAny = require('p-any')
 
 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 {Multiaddr[]} options.addrs
    * @param {function(Multiaddr):Promise<Connection>} options.dialAction