Files: 73683cb570cf00ded6a569f3b48e6b0eb4ccc69c / tmpl / apis / scuttlebot / friends.md
1849 bytesRaw
scuttlebot friends plugin
Query the follow and flag graphs.
all: async
Fetch the graph structure.
all [graph]
all(graph, cb)
graph
(string, default:follow
): Which graph to view. May befollow
orflag
.
hops: async
List the degrees-of-connection of all known feeds from the given feed.
hops [start] [graph] [--dunbar number] [--hops number]
hops(start, graph, { dunbar:, hops: }, cb)
start
(FeedID, default: local user): Which feed to start from.graph
(string, default:follow
): Which graph to view. May befollow
orflag
.dunbar
(number, default: 150): Limit on how many feeds to include in the list.hops
(number, default: 3): Limit on how many hops out the feed needs to be, to be included.
createFriendStream: source
Live-stream the ids of feeds which meet the given hops query. If meta
option is set, then will return steam of {id, hops}
createFriendStream
[--start feedid]
[--graph follow|flag]
[--dunbar number]
[--hops number]
[--meta]
createFriendStream({
start:,
graph:,
dunbar:,
hops:,
meta:
}, cb)
start
(FeedID, default: local user): Which feed to start from.graph
(string, default:follow
): Which graph to view. May befollow
orflag
.dunbar
(number, default: 150): Limit on how many feeds to include in the list.hops
(number, default: 3): Limit on how many hops out the feed needs to be, to be included.
get: sync
Get the edge between two different feeds.
get --source {feedid} --dest {feedid} [--graph follow|flag]
get({ source:, dest:, graph: }, cb)
source
(FeedID): Edge source.dest
(FeedID): Edge destination.graph
(string, default:follow
): Which graph to query. May befollow
orflag
.
Built with git-ssb-web