orbitdb/orbit-db
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add doc for peer event

Browse Source
This commit is contained in:
phillmac 2019-09-19 19:18:16 +10:00 committed by GitHub
parent 7902972277
commit 9d639eeaaa
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
API.md
View File

@ -62,6 +62,7 @@ Read the **[GETTING STARTED](https://github.com/orbitdb/orbit-db/blob/master/GUI
+ [`load.progress`](#loadprogress)
* [`ready`](#ready)
* [`write`](#write)
* [`peer`](#peer)
* [`closed`](#closed)
<!-- tocstop -->
@ -603,6 +604,13 @@ db.events.on('write', (dbname, hash, entry) => ... )
Emitted after an entry was added locally to the database. *hash* is the IPFS hash of the latest state of the database. *entry* is the added database op.
### `peer`
```javascript
db.events.on('peer', (peer) => ... )
```
Emitted when a new peer connects via ipfs pubsub. *peer* is the new peer, an instance of [`peerInfo`](https://github.com/libp2p/js-peer-info)
### `closed`
Emitted once the database has finished closing.
```javascript