docs: new api #472

vasco-santos · 2019-11-03T11:19:16Z

New API documentation for the async refactor

API.md

alanshaw

Just some suggestions 🤷‍♂️ 😁

API.md

alanshaw · 2019-11-29T15:27:37Z

API.md

+
+| Name | Type | Description |
+|------|------|-------------|
+| options | `Object` | libp2p options |


What are the options?

I would like to have a specific MD doc for the options/libp2p configuration, where this would point out. As there are so many options and instructions for configuration, I think it will be easier for people reading the docs to digest a lighter API, while being able to consult the options when needed. What do you think?

I think linking to a second doc for that would be useful. There is a lot of possible configuration, so avoiding that overwhelming this doc has merit.

I will create that in a new PR next week

So, after writting that in #495 , I think I will document the first level properties of the options object here and point to the other doc

API.md

alanshaw · 2019-11-29T15:55:28Z

API.md

+| Name | Type | Description |
+|------|------|-------------|
+| topic | `string` | topic to subscribe |
+| handler | `function(<Object>)` | handler for new data on topic |


Please describe the Object!

API.md

alanshaw · 2019-11-29T15:56:06Z

API.md

+
+Unsubscribes the given handler from a pubsub topic. If no handler is provided, all handlers for the topic are removed.
+
+`libp2p.pubsub.unsubscribe(topic)`


Suggested change

`libp2p.pubsub.unsubscribe(topic)`

`libp2p.pubsub.unsubscribe(topic, handler)`

Co-Authored-By: Alan Shaw <alan.shaw@protocol.ai>

API.md

jacobheun · 2019-11-29T16:27:26Z

API.md

+
+| Name | Type | Description |
+|------|------|-------------|
+| options | `Object` | libp2p options |


I think linking to a second doc for that would be useful. There is a lot of possible configuration, so avoiding that overwhelming this doc has merit.

API.md

jacobheun · 2019-11-29T16:58:09Z

API.md

+
+Unregisters all handlers with the given protocols
+
+`libp2p.unhandle(protocols)`


It sounds like we need to clarify how handle works in these docs. It's not possible to register multiple handlers for a given protocol. For example:

libp2p.handle('/echo/1.0.0', handler) libp2p.handle('/echo/1.0.0', otherHandler)

will only ever call otherHandler. If you think about this like setting up HTTP routes, you wouldn't route GET https://libp2p.io/protocol to two places. It's a n:1 routing system (protocols:route), rather than a subscription system.

So when you call unhandle, you are removing support for that protocol completely, and notifying peers (now that we have identify push) that's happening.

API.md

jacobheun · 2019-11-29T17:03:42Z

API.md

+Iterates over all content routers in series to find providers of the given key.
+Once a content router succeeds, the iteration will stop.
+
+`libp2p.contentRouting.findProviders(cid, options)`


👍 We haven't refactored this quite yet, should happen in the next day or two, and I intend to make all array based queries async iterable.

API.md

Co-Authored-By: Jacob Heun <jacobheun@gmail.com>

vasco-santos · 2019-12-03T15:19:49Z

README.md

-
-Some available network protectors:
-* [libp2p-pnet](https://github.com/libp2p/js-libp2p/tree/master/src/pnet)
+See [API.md](./doc/API.md).


I will add in the section before the configuration doc, which will also be linked from the API when relevant

jacobheun

Some minor things based on the most recent changes we've made. This is looking good!

doc/API.md

Co-Authored-By: Jacob Heun <jacobheun@gmail.com>

jacobheun

This LGTM. We can iterate any final changes we need to before the final release.

* docs: new api * chore: new iteration * chore: apply suggestions from code review Co-Authored-By: Alan Shaw <alan.shaw@protocol.ai> * chore: apply suggestions from code review Co-Authored-By: Jacob Heun <jacobheun@gmail.com> * chore: address review * docs: add events * chore: apply suggestions from code review Co-Authored-By: Jacob Heun <jacobheun@gmail.com>

Send DHT query events to the onProgress callback if one is passed to allow operation-specific progress events to pass up the stack. Refs: libp2p#1574

## [9.2.0](libp2p/js-libp2p-kad-dht@v9.1.5...v9.2.0) (2023-05-05) ### Features * invoke onProgress callback if passed as an option ([libp2p#472](libp2p/js-libp2p-kad-dht#472)) ([0bef25f](libp2p/js-libp2p-kad-dht@0bef25f))

daviddias reviewed Nov 12, 2019

View reviewed changes

API.md Outdated Show resolved Hide resolved

API.md Outdated Show resolved Hide resolved

alanshaw reviewed Nov 18, 2019

View reviewed changes

API.md Outdated Show resolved Hide resolved

API.md Outdated Show resolved Hide resolved

API.md Outdated Show resolved Hide resolved

vasco-santos mentioned this pull request Nov 21, 2019

refactor: dht #480

Merged

1 task

docs: new api

e244170

vasco-santos force-pushed the docs/new-api branch from 9eeef61 to 4ed4c60 Compare November 29, 2019 13:58

chore: new iteration

e9158bd

vasco-santos force-pushed the docs/new-api branch from 4ed4c60 to e9158bd Compare November 29, 2019 14:06

vasco-santos marked this pull request as ready for review November 29, 2019 14:06

vasco-santos requested review from alanshaw, daviddias and jacobheun November 29, 2019 14:06

alanshaw suggested changes Nov 29, 2019

View reviewed changes

chore: apply suggestions from code review

4d9eabd

Co-Authored-By: Alan Shaw <alan.shaw@protocol.ai>

jacobheun reviewed Nov 29, 2019

View reviewed changes

jacobheun mentioned this pull request Nov 29, 2019

⚡️ 0.27 RELEASE 🚀 The Async / Await refactor #487

Closed

vasco-santos and others added 2 commits December 1, 2019 19:55

chore: apply suggestions from code review

cfa0136

Co-Authored-By: Jacob Heun <jacobheun@gmail.com>

chore: address review

5de2e22

vasco-santos force-pushed the docs/new-api branch from 4fba39c to 5de2e22 Compare December 1, 2019 19:58

vasco-santos commented Dec 3, 2019

View reviewed changes

docs: add events

5699779

vasco-santos force-pushed the docs/new-api branch from f6d8000 to 5699779 Compare December 4, 2019 17:10

vasco-santos requested review from alanshaw and jacobheun December 4, 2019 17:11

jacobheun reviewed Dec 6, 2019

View reviewed changes

doc/API.md Outdated Show resolved Hide resolved

doc/API.md Outdated Show resolved Hide resolved

doc/API.md Outdated Show resolved Hide resolved

chore: apply suggestions from code review

40e3e6b

Co-Authored-By: Jacob Heun <jacobheun@gmail.com>

jacobheun approved these changes Dec 10, 2019

View reviewed changes

jacobheun merged commit ca474fd into refactor/async-await Dec 10, 2019

daviddias deleted the docs/new-api branch December 10, 2019 16:00

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: new api #472

docs: new api #472

vasco-santos commented Nov 3, 2019

alanshaw left a comment

alanshaw Nov 29, 2019

vasco-santos Nov 29, 2019

jacobheun Nov 29, 2019

vasco-santos Dec 1, 2019

vasco-santos Dec 4, 2019

alanshaw Nov 29, 2019

alanshaw Nov 29, 2019

jacobheun Nov 29, 2019

jacobheun Nov 29, 2019

jacobheun Nov 29, 2019

vasco-santos Dec 3, 2019

jacobheun left a comment

jacobheun left a comment


		Unsubscribes the given handler from a pubsub topic. If no handler is provided, all handlers for the topic are removed.

		`libp2p.pubsub.unsubscribe(topic)`

	`libp2p.pubsub.unsubscribe(topic)`
	`libp2p.pubsub.unsubscribe(topic, handler)`


		Unregisters all handlers with the given protocols

		`libp2p.unhandle(protocols)`

docs: new api #472

docs: new api #472

Conversation

vasco-santos commented Nov 3, 2019

alanshaw left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jacobheun left a comment

Choose a reason for hiding this comment

jacobheun left a comment

Choose a reason for hiding this comment