Skip to content
This repository was archived by the owner on Jun 26, 2023. It is now read-only.

docs: fix typos in docs #386

Merged
merged 2 commits into from
Apr 25, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions packages/interface-libp2p/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ export interface PeerUpdate {
* Once you have a libp2p instance, you can listen to several events it emits,
* so that you can be notified of relevant network events.
*
* Event names are `noun:adjective` so the first part is the name of the object
* Event names are `noun:verb` so the first part is the name of the object
* being acted on and the second is the action.
*/
export interface Libp2pEvents {
Expand All @@ -69,7 +69,7 @@ export interface Libp2pEvents {
'peer:discovery': CustomEvent<PeerInfo>

/**
* This event will be triggered anytime a new peer connects.
* This event will be triggered any time a new peer connects.
*
* @example
*
Expand All @@ -83,7 +83,7 @@ export interface Libp2pEvents {
'peer:connect': CustomEvent<PeerId>

/**
* This event will be triggered anytime we are disconnected from another peer, regardless of
* This event will be triggered any time we are disconnected from another peer, regardless of
* the circumstances of that disconnection. If we happen to have multiple connections to a
* peer, this event will **only** be triggered when the last connection is closed.
*
Expand Down
2 changes: 1 addition & 1 deletion packages/interface-transport/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ A valid transport (one that follows the interface defined) must implement the fo
Upgraders have 2 methods: `upgradeOutbound` and `upgradeInbound`.

- `upgradeOutbound` must be called and returned by `transport.dial`.
- `upgradeInbound` must be called and the results must be passed to the `createListener` `handlerFunction` and the `connection` event handler, anytime a new connection is created.
- `upgradeInbound` must be called and the results must be passed to the `createListener` `handlerFunction` and the `connection` event handler, any time a new connection is created.

```js
const connection = await upgrader.upgradeOutbound(multiaddrConnection)
Expand Down