coracle/welshman
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update readme

Browse Source
This commit is contained in:
Jon Staab
2024-11-20 15:46:06 -08:00
parent 3cb85a7b70
commit 2848310d91
1 changed files with 11 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/net/README.md
+11 -9
View File
@@ -2,19 +2,21 @@
Utilities having to do with connection management and nostr messages.
- `Connection` - a wrapper for `Socket` with send and receive queues, and a `ConnectionMeta` instance.
- `ConnectionMeta` - tracks stats for a given `Connection`.
- `Context` - an object containing a default `Pool` and global configuration options.
- `Connection` - the main api for dealing with relay connections
- `ConnectionAuth` - tracks auth status for a connection
- `ConnectionSender` - a send queue for connections
- `ConnectionState` - tracks pending publishes and requests for a connection
- `ConnectionStats` - tracks timing and error stats for a connection
- `Context` - provides default values for configuring `ctx.net`
- `Executor` - implements common nostr flows on a given `target`
- `Pool` - a thin wrapper around `Map` which stores `Connection`s.
- `Publish` - utilities for publishing events.
- `Socket` - a wrapper around isomorphic-ws that handles json parsing/serialization.
- `Subscribe` - utilities for making requests against nostr relays.
- `Tracker` - tracks which relays a given event was seen on.
- `Pool` - a thin wrapper around `Map` which stores `Connection`s
- `Publish` - utilities for publishing events
- `Socket` - a wrapper around isomorphic-ws that handles json parsing/serialization
- `Subscribe` - utilities for making requests against nostr relays
- `Tracker` - tracks which relays a given event was seen on
Executor `target`s extend `Emitter`, and have a `send` method, a `cleanup` method, and a `connections` getter. They are intended to be passed to an `Executor` for use.
- `targets/Multi` allows you to compose multiple targets together.
- `targets/Plex` takes an array of urls and a `Connection` and sends and receives wrapped nostr messages over that connection.
- `targets/Relay` takes a `Connection` and provides listeners for different verbs.
- `targets/Relays` takes an array of `Connection`s and provides listeners for different verbs, merging all events into a single stream.