search

ssbc / ssb-conn

SSB plugin for establishing and managing peer connections
MIT License
16 stars 5 forks source link

Add details about entry `data` #7

Closed mixmix closed 4 years ago

mixmix commented 4 years ago

I found myself console.logging to figure out what data I could play with in some of the methods This is me noting what I've seen I think this is important so people know the entries are not isomorphic

:fire: NOTE some of this is best-guess (even more reason to try documenting), and there's definitely parts missing in this.

mixmix commented 4 years ago

Request - specifically I want to know whether it's ok to lean on type and inferredType and what the difference is, and when I can expect to see one or the other. Like for peers() will it give me a type if it is known, and if not does it fall back to inferredType?

staltz commented 4 years ago

Great PR! Actually I'm waiting for feedback from you and others who maintain Patchbay and Patchwork before publishing ssb-conn v1.0.0, so now is the time to make this module feel right.

Most of your guesses were correct. I'll edit this file in such a way that answers your questions, you'll then see from my commit what that is.

staltz commented 4 years ago

And in general, do you have feedback about the API? I was thinking that maybe ssb.conn.peers() is a confusing API, maybe it should be hubPeers()? So that it's always clear what the pool is:

Also I'm considering whether to rename birth to dbBirth so there is the same symmetry:

mixmix commented 4 years ago

@staltz I like dbBirth

I don't know what "hub" means ... I seem to remember it's an internal thing. what I'd be looking for is :

staltz commented 4 years ago

Mix that's a quite accurate intuition:

Does this answer what you want? By the way, I'll merge this (it has commits from both of us).

staltz commented 4 years ago

PS: what about the Learn More section? Was that helpful?

mixmix commented 4 years ago

Yeah that was useful (learn more).

My main feedback is that "hub" is not intuitive for what's more like "current" or "live". Huh just sounds like what everything is connecting to...

Caught a typo in learn more: ConnDB contains metadata on stable servers and peers that have been successfully connectable connected to

On Tue, 3 Dec 2019, 10:42 André Staltz, notifications@github.com wrote:

PS: what about the Learn More https://github.com/staltz/ssb-conn#learn-more section? Was that helpful?

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/staltz/ssb-conn/pull/7?email_source=notifications&email_token=AAUK3HRDRQBZF5L5JUYDJF3QWV6NNA5CNFSM4ISH5DL2YY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOEFVJ3TA#issuecomment-560635340, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAUK3HTMRBPA7BNXHC4Y73TQWV6NNANCNFSM4ISH5DLQ .