Browse Source

Merge pull request #687 from mhchia/patch-1

Fix misplaced method descriptions in docstring
Alex Sosnovskiy 5 years ago
parent
commit
73ad350b55
1 changed files with 3 additions and 3 deletions
  1. 3 3
      index.d.ts

+ 3 - 3
index.d.ts

@@ -22,20 +22,20 @@ declare class Peer {
   constructor(options: Peer.PeerJSOption);
 
   /**
-   *
+   * Connects to the remote peer specified by id and returns a data connection.
    * @param id The brokering ID of the remote peer (their peer.id).
    * @param options for specifying details about Peer Connection
    */
   connect(id: string, options?: Peer.PeerConnectOption): Peer.DataConnection;
   /**
-   * Connects to the remote peer specified by id and returns a data connection.
+   * Calls the remote peer specified by id and returns a media connection.
    * @param id The brokering ID of the remote peer (their peer.id).
    * @param stream The caller's media stream
    * @param options Metadata associated with the connection, passed in by whoever initiated the connection.
    */
   call(id: string, stream: MediaStream, options?: Peer.CallOption): Peer.MediaConnection;
   /**
-   * Calls the remote peer specified by id and returns a media connection.
+   * Set listeners for peer events.
    * @param event Event name
    * @param cb Callback Function
    */