Skip to content

Commit

Permalink
chore: fix api formatting (#644)
Browse files Browse the repository at this point in the history
  • Loading branch information
@wemeetagain @jacobheun
wemeetagain authored and jacobheun committed May 28, 2020
1 parent 166d705 commit 24a148f
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions doc/API.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -906,7 +906,7 @@ Get the known `PublicKey` of a provided peer.

| Type | Description |
|------|-------------|
| `RsaPublicKey|Ed25519PublicKey|Secp256k1PublicKey` | Peer PublicKey |
| [`RsaPublicKey\|Ed25519PublicKey\|Secp256k1PublicKey`][keys] | Peer PublicKey |

#### Example

Expand All @@ -929,7 +929,7 @@ Set known `peerId`. This can include its Public Key.
| Name | Type | Description |
|------|------|-------------|
| peerId | [`PeerId`][peer-id] | peerId to set |
| publicKey | [`RsaPublicKey|Ed25519PublicKey|Secp256k1PublicKey`][keys] | peer's public key |
| publicKey | [`RsaPublicKey\|Ed25519PublicKey\|Secp256k1PublicKey`][keys] | peer's public key |

#### Returns

Expand Down Expand Up @@ -1884,4 +1884,4 @@ This event will be triggered anytime we are disconnected from another peer, rega
[connection]: https://github.com/libp2p/js-interfaces/tree/master/src/connection
[multiaddr]: https://github.com/multiformats/js-multiaddr
[peer-id]: https://github.com/libp2p/js-peer-id
[keys]: https://github.com/libp2p/js-libp2p-crypto/tree/master/src/keys
[keys]: https://github.com/libp2p/js-libp2p-crypto/tree/master/src/keys

0 comments on commit 24a148f

Please sign in to comment.