Update docs
This commit is contained in:
@@ -32,10 +32,10 @@ export class FeedController {
|
||||
load(limit: number): Promise<void>
|
||||
|
||||
// Get listener function (memoized)
|
||||
getListener(): Promise<() => Promise<void>>
|
||||
getListener(): Promise<() => () => void>
|
||||
|
||||
// Listen for new events in the feed
|
||||
listen(): Promise<void>
|
||||
// Listen for new events in the feed; returns an unsubscribe function
|
||||
listen(): () => Promise<void>
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
+9
-11
@@ -18,31 +18,29 @@ Read the spec on [the NIPs repository](https://github.com/nostr-protocol/nips/bl
|
||||
|
||||
```javascript
|
||||
// Define a feed using set operations
|
||||
const feed = intersectionFeed(
|
||||
unionFeed(
|
||||
dvmFeed({
|
||||
const feed = makeIntersectionFeed(
|
||||
makeUnionFeed(
|
||||
makeDVMFeed({
|
||||
kind: 5300,
|
||||
pubkey: '19b78ccfa7c5e31e6bacbb3f2a1703f64b62017702e584440bf29a7e16263e8c',
|
||||
}),
|
||||
listFeed("10003:19ba654f26afd4930fd3d51baf4e26f1413b7aeec7190cd6c0cdf4d2f14cec6b:"),
|
||||
)
|
||||
wotFeed({min: 0.1}),
|
||||
scopeFeed("global"),
|
||||
makeListFeed("10003:19ba654f26afd4930fd3d51baf4e26f1413b7aeec7190cd6c0cdf4d2f14cec6b:"),
|
||||
),
|
||||
makeWOTFeed({min: 0.1}),
|
||||
makeGlobalFeed(),
|
||||
)
|
||||
|
||||
// Create a controller, providing required context via FeedOptions
|
||||
const controller = new FeedController({
|
||||
feed,
|
||||
request,
|
||||
requestDVM,
|
||||
getPubkeysForScope,
|
||||
getPubkeysForWOTRange,
|
||||
onEvent: event => console.log("Event", event),
|
||||
onExhausted: () => console.log("Exhausted"),
|
||||
})
|
||||
|
||||
// Load notes using the feed
|
||||
const events = await controller.load(10)
|
||||
// Load notes using the feed — events are delivered via the onEvent callback above
|
||||
await controller.load(10)
|
||||
```
|
||||
|
||||
## Installation
|
||||
|
||||
Reference in New Issue
Block a user