feat!: added method to cancel a pending dial by it's id

packages/interface-connection-manager/src/index.ts

@@ -76,4 +76,18 @@ export interface ConnectionManager {
    * ```
    */
   getDialQueue: () => PendingDial[]
+
+  /**
+   * Cancel a pending dial by removing it from the queue and rejecting all promises associated with it
+   *
+   * @param {string} id - The id of the dial to cancel
+   *
+   * @example
+   *
+   * ```js
+   * const dialId = libp2p.connectionManager.getDialQueue()[0].id
+   * libp2p.connectionManager.cancelDial(dial-id)
+   * ```
+   */
+  cancelDial: (id: string) => void
 }

packages/interface-libp2p/src/index.ts

@@ -444,6 +444,18 @@ export interface Libp2p extends Startable, EventEmitter<Libp2pEvents> {
    */
   getDialQueue: () => PendingDial[]
 
+  /**
+   * Cancel a pending dial by its id
+   *
+   * @example
+   *
+   * ```js
+   * const dialId = libp2p.getDialQueue()[0].id
+   * libp2p.cancelDial(dialId)
+   * ```
+   */
+  cancelDial: (id: string) => void
+
   /**
    * Return a list of all peers we currently have a connection open to
    */

packages/interface-mocks/src/connection-manager.ts

@@ -192,6 +192,8 @@ class MockConnectionManager implements ConnectionManager, Startable {
   getDialQueue (): PendingDial[] {
     return []
   }
+
+  cancelDial (): void {}
 }
 
 export function mockConnectionManager (components: MockConnectionManagerComponents): ConnectionManager {