Welshman Docs / @welshman/feeds
@welshman/feeds
Enumerations
FeedType
Defined in: feeds/src/core.ts:3
Enumeration Members
Address
Address:
"address"
Defined in: feeds/src/core.ts:4
Author
Author:
"author"
Defined in: feeds/src/core.ts:5
CreatedAt
CreatedAt:
"created_at"
Defined in: feeds/src/core.ts:6
Difference
Difference:
"difference"
Defined in: feeds/src/core.ts:8
DVM
DVM:
"dvm"
Defined in: feeds/src/core.ts:7
Global
Global:
"global"
Defined in: feeds/src/core.ts:11
ID
ID:
"id"
Defined in: feeds/src/core.ts:9
Intersection
Intersection:
"intersection"
Defined in: feeds/src/core.ts:10
Kind
Kind:
"kind"
Defined in: feeds/src/core.ts:12
Label
Label:
"label"
Defined in: feeds/src/core.ts:14
List
List:
"list"
Defined in: feeds/src/core.ts:13
Relay
Relay:
"relay"
Defined in: feeds/src/core.ts:16
Scope
Scope:
"scope"
Defined in: feeds/src/core.ts:17
Search
Search:
"search"
Defined in: feeds/src/core.ts:18
Tag
Tag:
"tag"
Defined in: feeds/src/core.ts:19
Union
Union:
"union"
Defined in: feeds/src/core.ts:20
WOT
WOT:
"wot"
Defined in: feeds/src/core.ts:15
Scope
Defined in: feeds/src/core.ts:23
Enumeration Members
Followers
Followers:
"followers"
Defined in: feeds/src/core.ts:24
Follows
Follows:
"follows"
Defined in: feeds/src/core.ts:25
Network
Network:
"network"
Defined in: feeds/src/core.ts:26
Self
Self:
"self"
Defined in: feeds/src/core.ts:27
Classes
Interfaces
Type Aliases
AddressFeed
AddressFeed = [
Address,string[]]
Defined in: feeds/src/core.ts:70
AuthorFeed
AuthorFeed = [
Author,string[]]
Defined in: feeds/src/core.ts:71
CreatedAtFeed
CreatedAtFeed = [
CreatedAt,CreatedAtItem[]]
Defined in: feeds/src/core.ts:72
CreatedAtItem
CreatedAtItem =
object
Defined in: feeds/src/core.ts:64
Properties
relative?
optionalrelative:string[]
Defined in: feeds/src/core.ts:67
since?
optionalsince:number
Defined in: feeds/src/core.ts:65
until?
optionaluntil:number
Defined in: feeds/src/core.ts:66
DifferenceFeed
DifferenceFeed = [
Difference,Feed[]]
Defined in: feeds/src/core.ts:74
DVMFeed
Defined in: feeds/src/core.ts:73
DVMItem
DVMItem =
object
Defined in: feeds/src/core.ts:40
Properties
kind
kind:
number
Defined in: feeds/src/core.ts:41
mappings?
optionalmappings:TagFeedMapping[]
Defined in: feeds/src/core.ts:44
relays?
optionalrelays:string[]
Defined in: feeds/src/core.ts:43
tags?
optionaltags:string[][]
Defined in: feeds/src/core.ts:42
Feed
Feed =
AddressFeed|AuthorFeed|CreatedAtFeed|DVMFeed|DifferenceFeed|IDFeed|IntersectionFeed|GlobalFeed|KindFeed|ListFeed|LabelFeed|WOTFeed|RelayFeed|ScopeFeed|SearchFeed|TagFeed|UnionFeed
Defined in: feeds/src/core.ts:88
FeedCompilerOptions
FeedCompilerOptions =
object
Defined in: feeds/src/compiler.ts:28
Properties
context?
optionalcontext:AdapterContext
Defined in: feeds/src/compiler.ts:32
getPubkeysForScope()
getPubkeysForScope: (
scope) =>string[]
Defined in: feeds/src/compiler.ts:33
Parameters
scope
Returns
string[]
getPubkeysForWOTRange()
getPubkeysForWOTRange: (
minWOT,maxWOT) =>string[]
Defined in: feeds/src/compiler.ts:34
Parameters
minWOT
number
maxWOT
number
Returns
string[]
router
router:
FeedRouter
Defined in: feeds/src/compiler.ts:29
signal?
optionalsignal:AbortSignal
Defined in: feeds/src/compiler.ts:31
signer?
optionalsigner:ISigner
Defined in: feeds/src/compiler.ts:30
FeedControllerOptions
FeedControllerOptions =
FeedCompilerOptions&object
Defined in: feeds/src/controller.ts:19
Type declaration
feed
feed:
Feed
onEvent()?
optionalonEvent: (event) =>void
Parameters
event
Returns
void
onExhausted()?
optionalonExhausted: () =>void
Returns
void
tracker?
optionaltracker:Tracker
useWindowing?
optionaluseWindowing:boolean
FilterFeedType
Defined in: feeds/src/core.ts:30
GlobalFeed
Defined in: feeds/src/core.ts:77
IDFeed
IDFeed = [
ID,string[]]
Defined in: feeds/src/core.ts:75
IntersectionFeed
IntersectionFeed = [
Intersection,Feed[]]
Defined in: feeds/src/core.ts:76
KindFeed
KindFeed = [
Kind,number[]]
Defined in: feeds/src/core.ts:78
LabelFeed
Defined in: feeds/src/core.ts:80
LabelItem
LabelItem =
object
Defined in: feeds/src/core.ts:52
Indexable
[key: `#${string}`]: string[]
Properties
authors?
optionalauthors:string[]
Defined in: feeds/src/core.ts:54
mappings?
optionalmappings:TagFeedMapping[]
Defined in: feeds/src/core.ts:56
relays?
optionalrelays:string[]
Defined in: feeds/src/core.ts:53
ListFeed
Defined in: feeds/src/core.ts:79
ListItem
ListItem =
object
Defined in: feeds/src/core.ts:47
Properties
addresses
addresses:
string[]
Defined in: feeds/src/core.ts:48
mappings?
optionalmappings:TagFeedMapping[]
Defined in: feeds/src/core.ts:49
RelayFeed
RelayFeed = [
Relay,string[]]
Defined in: feeds/src/core.ts:82
RelaysAndFilters
RelaysAndFilters =
object
Defined in: feeds/src/router.ts:22
Properties
filters
filters:
Filter[]
Defined in: feeds/src/router.ts:22
relays
relays:
string[]
Defined in: feeds/src/router.ts:22
RequestItem
RequestItem =
object
Defined in: feeds/src/core.ts:107
Properties
filters?
optionalfilters:Filter[]
Defined in: feeds/src/core.ts:109
relays?
optionalrelays:string[]
Defined in: feeds/src/core.ts:108
ScopeFeed
Defined in: feeds/src/core.ts:83
SearchFeed
SearchFeed = [
Search,string[]]
Defined in: feeds/src/core.ts:84
TagFeed
TagFeed = [
Tag,string,string[]]
Defined in: feeds/src/core.ts:85
TagFeedMapping
TagFeedMapping = [
string,Feed]
Defined in: feeds/src/core.ts:38
UnionFeed
Defined in: feeds/src/core.ts:86
WOTFeed
Defined in: feeds/src/core.ts:81
WOTItem
WOTItem =
object
Defined in: feeds/src/core.ts:59
Properties
max?
optionalmax:number
Defined in: feeds/src/core.ts:61
min?
optionalmin:number
Defined in: feeds/src/core.ts:60
Variables
defaultTagFeedMappings
constdefaultTagFeedMappings:TagFeedMapping[]
Defined in: feeds/src/utils.ts:144
validateAddressFeed()
constvalidateAddressFeed: (feed) =>any
Defined in: feeds/src/validate.ts:49
Parameters
feed
any
Returns
any
validateAuthorFeed()
constvalidateAuthorFeed: (feed) =>any
Defined in: feeds/src/validate.ts:51
Parameters
feed
any
Returns
any
validateCreatedAtFeed()
constvalidateCreatedAtFeed: (feed) =>any
Defined in: feeds/src/validate.ts:53
Parameters
feed
any
Returns
any
validateDifferenceFeed()
constvalidateDifferenceFeed: (feed) =>any
Defined in: feeds/src/validate.ts:70
Parameters
feed
any
Returns
any
validateDVMFeed()
constvalidateDVMFeed: (feed) =>any
Defined in: feeds/src/validate.ts:61
Parameters
feed
any
Returns
any
validateGlobalFeed()
constvalidateGlobalFeed: (feed) =>any
Defined in: feeds/src/validate.ts:76
Parameters
feed
any
Returns
any
validateIDFeed()
constvalidateIDFeed: (feed) =>any
Defined in: feeds/src/validate.ts:72
Parameters
feed
any
Returns
any
validateIntersectionFeed()
constvalidateIntersectionFeed: (feed) =>any
Defined in: feeds/src/validate.ts:74
Parameters
feed
any
Returns
any
validateKindFeed()
constvalidateKindFeed: (feed) =>any
Defined in: feeds/src/validate.ts:78
Parameters
feed
any
Returns
any
validateLabelFeed()
constvalidateLabelFeed: (feed) =>any
Defined in: feeds/src/validate.ts:87
Parameters
feed
any
Returns
any
validateListFeed()
constvalidateListFeed: (feed) =>any
Defined in: feeds/src/validate.ts:80
Parameters
feed
any
Returns
any
validateRelayFeed()
constvalidateRelayFeed: (feed) =>any
Defined in: feeds/src/validate.ts:125
Parameters
feed
any
Returns
any
validateScopeFeed()
constvalidateScopeFeed: (feed) =>any
Defined in: feeds/src/validate.ts:127
Parameters
feed
any
Returns
any
validateSearchFeed()
constvalidateSearchFeed: (feed) =>any
Defined in: feeds/src/validate.ts:129
Parameters
feed
any
Returns
any
validateTagFeed()
constvalidateTagFeed: (feed) =>any
Defined in: feeds/src/validate.ts:131
Parameters
feed
any
Returns
any
validateTagFeedMapping
constvalidateTagFeedMapping:Validator
Defined in: feeds/src/validate.ts:30
validateUnionFeed()
constvalidateUnionFeed: (feed) =>any
Defined in: feeds/src/validate.ts:133
Parameters
feed
any
Returns
any
validateWOTFeed()
constvalidateWOTFeed: (feed) =>any
Defined in: feeds/src/validate.ts:118
Parameters
feed
any
Returns
any
ValidationError
ValidationError: typeof
ValidationError
Defined in: feeds/src/validate.ts:7
Functions
displayAddressFeed()
displayAddressFeed(
feed):string
Defined in: feeds/src/display.ts:25
Parameters
feed
Returns
string
displayAuthorFeed()
displayAuthorFeed(
feed):string
Defined in: feeds/src/display.ts:31
Parameters
feed
Returns
string
displayCreatedAtFeed()
displayCreatedAtFeed(
feed):string
Defined in: feeds/src/display.ts:37
Parameters
feed
Returns
string
displayDifferenceFeed()
displayDifferenceFeed(
feed):string
Defined in: feeds/src/display.ts:95
Parameters
feed
Returns
string
displayDVMFeed()
displayDVMFeed(
feed):string
Defined in: feeds/src/display.ts:72
Parameters
feed
Returns
string
displayFeed()
displayFeed(
feed):string
Defined in: feeds/src/display.ts:169
Parameters
feed
Returns
string
displayFeeds()
displayFeeds(
feeds):string
Defined in: feeds/src/display.ts:210
Parameters
feeds
Feed[]
Returns
string
displayGlobalFeed()
displayGlobalFeed(
feed):string
Defined in: feeds/src/display.ts:106
Parameters
feed
Returns
string
displayIDFeed()
displayIDFeed(
feed):string
Defined in: feeds/src/display.ts:101
Parameters
feed
Returns
string
displayIntersectionFeed()
displayIntersectionFeed(
feed):string
Defined in: feeds/src/display.ts:103
Parameters
feed
Returns
string
displayKindFeed()
displayKindFeed(
feed):string
Defined in: feeds/src/display.ts:108
Parameters
feed
Returns
string
displayLabelFeed()
displayLabelFeed(
feed):string
Defined in: feeds/src/display.ts:116
Parameters
feed
Returns
string
displayListFeed()
displayListFeed(
feed):string
Defined in: feeds/src/display.ts:110
Parameters
feed
Returns
string
displayRelayFeed()
displayRelayFeed(
feed):string
Defined in: feeds/src/display.ts:153
Parameters
feed
Returns
string
displayScopeFeed()
displayScopeFeed(
feed):string
Defined in: feeds/src/display.ts:155
Parameters
feed
Returns
string
displaySearchFeed()
displaySearchFeed(
feed):string
Defined in: feeds/src/display.ts:158
Parameters
feed
Returns
string
displayTagFeed()
displayTagFeed(
feed):string
Defined in: feeds/src/display.ts:161
Parameters
feed
Returns
string
displayUnionFeed()
displayUnionFeed(
feed):string
Defined in: feeds/src/display.ts:167
Parameters
feed
Returns
string
displayWOTFeed()
displayWOTFeed(
feed):string
Defined in: feeds/src/display.ts:145
Parameters
feed
Returns
string
feedFromFilter()
feedFromFilter(
filter):AuthorFeed|CreatedAtFeed|IDFeed|IntersectionFeed|KindFeed|TagFeed
Defined in: feeds/src/utils.ts:195
Parameters
filter
Returns
AuthorFeed | CreatedAtFeed | IDFeed | IntersectionFeed | KindFeed | TagFeed
feedFromFilters()
feedFromFilters(
filters):AuthorFeed|CreatedAtFeed|IDFeed|IntersectionFeed|KindFeed|TagFeed|UnionFeed
Defined in: feeds/src/utils.ts:201
Parameters
filters
Filter[]
Returns
AuthorFeed | CreatedAtFeed | IDFeed | IntersectionFeed | KindFeed | TagFeed | UnionFeed
feedFromTags()
feedFromTags(
tags,mappings?):IntersectionFeed
Defined in: feeds/src/utils.ts:170
Parameters
tags
string[][]
mappings?
Returns
feedsFromFilter()
feedsFromFilter(
__namedParameters): (AuthorFeed|CreatedAtFeed|IDFeed|KindFeed|TagFeed)[]
Defined in: feeds/src/utils.ts:173
Parameters
__namedParameters
Returns
(AuthorFeed | CreatedAtFeed | IDFeed | KindFeed | TagFeed)[]
feedsFromTags()
feedsFromTags(
tags,mappings?): (AddressFeed|AuthorFeed|CreatedAtFeed|DVMFeed|DifferenceFeed|IDFeed|IntersectionFeed|GlobalFeed|KindFeed|ListFeed|LabelFeed|WOTFeed|RelayFeed|ScopeFeed|SearchFeed|TagFeed|UnionFeed)[]
Defined in: feeds/src/utils.ts:152
Parameters
tags
string[][]
mappings?
Returns
(AddressFeed | AuthorFeed | CreatedAtFeed | DVMFeed | DifferenceFeed | IDFeed | IntersectionFeed | GlobalFeed | KindFeed | ListFeed | LabelFeed | WOTFeed | RelayFeed | ScopeFeed | SearchFeed | TagFeed | UnionFeed)[]
findFeed()
findFeed(
feed,match):undefined|Feed
Defined in: feeds/src/utils.ts:217
Parameters
feed
match
(feed) => boolean
Returns
undefined | Feed
getFeedArgs()
Call Signature
getFeedArgs(
feed):Feed[]
Defined in: feeds/src/utils.ts:87
Parameters
feed
DifferenceFeed | IntersectionFeed | UnionFeed
Returns
Feed[]
Call Signature
getFeedArgs(
feed):string[]
Defined in: feeds/src/utils.ts:88
Parameters
feed
AddressFeed | AuthorFeed | IDFeed | RelayFeed | SearchFeed
Returns
string[]
Call Signature
getFeedArgs(
feed):CreatedAtItem[]
Defined in: feeds/src/utils.ts:91
Parameters
feed
Returns
Call Signature
getFeedArgs(
feed):ListItem[]
Defined in: feeds/src/utils.ts:92
Parameters
feed
Returns
ListItem[]
Call Signature
getFeedArgs(
feed):LabelItem[]
Defined in: feeds/src/utils.ts:93
Parameters
feed
Returns
Call Signature
getFeedArgs(
feed):DVMItem[]
Defined in: feeds/src/utils.ts:94
Parameters
feed
Returns
DVMItem[]
Call Signature
getFeedArgs(
feed):WOTItem[]
Defined in: feeds/src/utils.ts:95
Parameters
feed
Returns
WOTItem[]
Call Signature
getFeedArgs(
feed):Scope[]
Defined in: feeds/src/utils.ts:96
Parameters
feed
Returns
Scope[]
Call Signature
getFeedArgs(
feed):number[]
Defined in: feeds/src/utils.ts:97
Parameters
feed
Returns
number[]
Call Signature
getFeedArgs(
feed): [string,...string[]]
Defined in: feeds/src/utils.ts:98
Parameters
feed
Returns
[string, ...string[]]
Call Signature
getFeedArgs(
feed): []
Defined in: feeds/src/utils.ts:99
Parameters
feed
Returns
[]
getFilterSelections()
getFilterSelections(
filters,router):Promise<RelaysAndFilters[]>
Defined in: feeds/src/router.ts:54
Parameters
filters
Filter[]
router
Returns
Promise<RelaysAndFilters[]>
hasSubFeeds()
hasSubFeeds(
feed): feed is DifferenceFeed | IntersectionFeed | UnionFeed
Defined in: feeds/src/utils.ts:141
Parameters
feed
Returns
feed is DifferenceFeed | IntersectionFeed | UnionFeed
isAddressFeed()
isAddressFeed(
feed):feed is AddressFeed
Defined in: feeds/src/utils.ts:67
Parameters
feed
Returns
feed is AddressFeed
isAuthorFeed()
isAuthorFeed(
feed):feed is AuthorFeed
Defined in: feeds/src/utils.ts:68
Parameters
feed
Returns
feed is AuthorFeed
isCreatedAtFeed()
isCreatedAtFeed(
feed):feed is CreatedAtFeed
Defined in: feeds/src/utils.ts:69
Parameters
feed
Returns
feed is CreatedAtFeed
isDifferenceFeed()
isDifferenceFeed(
feed):feed is DifferenceFeed
Defined in: feeds/src/utils.ts:71
Parameters
feed
Returns
feed is DifferenceFeed
isDVMFeed()
isDVMFeed(
feed):feed is DVMFeed
Defined in: feeds/src/utils.ts:70
Parameters
feed
Returns
feed is DVMFeed
isGlobalFeed()
isGlobalFeed(
feed):feed is GlobalFeed
Defined in: feeds/src/utils.ts:76
Parameters
feed
Returns
feed is GlobalFeed
isIDFeed()
isIDFeed(
feed):feed is IDFeed
Defined in: feeds/src/utils.ts:73
Parameters
feed
Returns
feed is IDFeed
isIntersectionFeed()
isIntersectionFeed(
feed):feed is IntersectionFeed
Defined in: feeds/src/utils.ts:74
Parameters
feed
Returns
feed is IntersectionFeed
isKindFeed()
isKindFeed(
feed):feed is KindFeed
Defined in: feeds/src/utils.ts:77
Parameters
feed
Returns
feed is KindFeed
isLabelFeed()
isLabelFeed(
feed):feed is LabelFeed
Defined in: feeds/src/utils.ts:79
Parameters
feed
Returns
feed is LabelFeed
isListFeed()
isListFeed(
feed):feed is ListFeed
Defined in: feeds/src/utils.ts:78
Parameters
feed
Returns
feed is ListFeed
isRelayFeed()
isRelayFeed(
feed):feed is RelayFeed
Defined in: feeds/src/utils.ts:81
Parameters
feed
Returns
feed is RelayFeed
isScopeFeed()
isScopeFeed(
feed):feed is ScopeFeed
Defined in: feeds/src/utils.ts:82
Parameters
feed
Returns
feed is ScopeFeed
isSearchFeed()
isSearchFeed(
feed):feed is SearchFeed
Defined in: feeds/src/utils.ts:83
Parameters
feed
Returns
feed is SearchFeed
isTagFeed()
isTagFeed(
feed):feed is TagFeed
Defined in: feeds/src/utils.ts:84
Parameters
feed
Returns
feed is TagFeed
isUnionFeed()
isUnionFeed(
feed):feed is UnionFeed
Defined in: feeds/src/utils.ts:85
Parameters
feed
Returns
feed is UnionFeed
isWOTFeed()
isWOTFeed(
feed):feed is WOTFeed
Defined in: feeds/src/utils.ts:80
Parameters
feed
Returns
feed is WOTFeed
makeAddressFeed()
makeAddressFeed(...
addresses):AddressFeed
Defined in: feeds/src/utils.ts:33
Parameters
addresses
...string[]
Returns
makeAuthorFeed()
makeAuthorFeed(...
pubkeys):AuthorFeed
Defined in: feeds/src/utils.ts:37
Parameters
pubkeys
...string[]
Returns
makeCreatedAtFeed()
makeCreatedAtFeed(...
items):CreatedAtFeed
Defined in: feeds/src/utils.ts:38
Parameters
items
...CreatedAtItem[]
Returns
makeDifferenceFeed()
makeDifferenceFeed(...
feeds):DifferenceFeed
Defined in: feeds/src/utils.ts:43
Parameters
feeds
...Feed[]
Returns
makeDVMFeed()
makeDVMFeed(...
items):DVMFeed
Defined in: feeds/src/utils.ts:42
Parameters
items
...DVMItem[]
Returns
makeGlobalFeed()
makeGlobalFeed():
GlobalFeed
Defined in: feeds/src/utils.ts:52
Returns
makeIDFeed()
makeIDFeed(...
ids):IDFeed
Defined in: feeds/src/utils.ts:47
Parameters
ids
...string[]
Returns
makeIntersectionFeed()
makeIntersectionFeed(...
feeds):IntersectionFeed
Defined in: feeds/src/utils.ts:48
Parameters
feeds
...Feed[]
Returns
makeKindFeed()
makeKindFeed(...
kinds):KindFeed
Defined in: feeds/src/utils.ts:53
Parameters
kinds
...number[]
Returns
makeLabelFeed()
makeLabelFeed(...
items):LabelFeed
Defined in: feeds/src/utils.ts:55
Parameters
items
...LabelItem[]
Returns
makeListFeed()
makeListFeed(...
items):ListFeed
Defined in: feeds/src/utils.ts:54
Parameters
items
...ListItem[]
Returns
makeRelayFeed()
makeRelayFeed(...
urls):RelayFeed
Defined in: feeds/src/utils.ts:57
Parameters
urls
...string[]
Returns
makeScopeFeed()
makeScopeFeed(...
scopes):ScopeFeed
Defined in: feeds/src/utils.ts:58
Parameters
scopes
...Scope[]
Returns
makeSearchFeed()
makeSearchFeed(...
searches):SearchFeed
Defined in: feeds/src/utils.ts:59
Parameters
searches
...string[]
Returns
makeTagFeed()
makeTagFeed(
key, ...values):TagFeed
Defined in: feeds/src/utils.ts:60
Parameters
key
string
values
...string[]
Returns
makeUnionFeed()
makeUnionFeed(...
feeds):UnionFeed
Defined in: feeds/src/utils.ts:65
Parameters
feeds
...Feed[]
Returns
makeWOTFeed()
makeWOTFeed(...
items):WOTFeed
Defined in: feeds/src/utils.ts:56
Parameters
items
...WOTItem[]
Returns
simplifyFeed()
simplifyFeed(
feed):Feed
Defined in: feeds/src/utils.ts:231
Parameters
feed
Returns
validateFeed()
validateFeed(
feed):any
Defined in: feeds/src/validate.ts:135
Parameters
feed
any
Returns
any
validateFeedArgs()
validateFeedArgs(
validateArgument): (feed) =>any
Defined in: feeds/src/validate.ts:37
Parameters
validateArgument
Validator
Returns
(
feed):any
Parameters
feed
any
Returns
any
walkFeed()
walkFeed(
feed,visit):void
Defined in: feeds/src/utils.ts:207
Parameters
feed
visit
(feed) => void
Returns
void