Welshman Docs / @welshman/domain / CommunityListQuery

Class: CommunityListQuery

Defined in: kinds/CommunityList.ts:26

The read-side counterpart to EventWriter: a chainable builder for the filters that fetch a kind's events, plus the relays to request them from. The kind comes from the factory; each subclass implements renderRoutes to say where its events live, and adds any domain-specific methods (e.g. CommentQuery.forRoot).

Extends

• EventQuery

Constructors

Constructor

new CommunityListQuery(kind, context): CommunityListQuery

Defined in: core/EventQuery.ts:36

Parameters

kind

number

context

KindContext

Returns

CommunityListQuery

Inherited from

EventQuery.constructor

Properties

authors?

optional authors: string[]

Defined in: core/EventQuery.ts:27

Inherited from

EventQuery.authors

---

context

readonly context: KindContext

Defined in: core/EventQuery.ts:38

Inherited from

EventQuery.context

---

extraRoutes

extraRoutes: RelaySelection[] = []

Defined in: core/EventQuery.ts:34

Inherited from

EventQuery.extraRoutes

---

forcedRoutes?

optional forcedRoutes: RelaySelection[]

Defined in: core/EventQuery.ts:33

Inherited from

EventQuery.forcedRoutes

---

ids?

optional ids: string[]

Defined in: core/EventQuery.ts:26

Inherited from

EventQuery.ids

---

kind

readonly kind: number

Defined in: core/EventQuery.ts:37

Inherited from

EventQuery.kind

---

limit?

optional limit: number

Defined in: core/EventQuery.ts:30

Inherited from

EventQuery.limit

---

search?

optional search: string

Defined in: core/EventQuery.ts:31

Inherited from

EventQuery.search

---

since?

optional since: number

Defined in: core/EventQuery.ts:28

Inherited from

EventQuery.since

---

tagValues

tagValues: Map<string, string[]>

Defined in: core/EventQuery.ts:32

Inherited from

EventQuery.tagValues

---

until?

optional until: number

Defined in: core/EventQuery.ts:29

Inherited from

EventQuery.until

Methods

addAuthors()

addAuthors(authors): CommunityListQuery

Defined in: core/EventQuery.ts:71

Parameters

authors

string[]

Returns

CommunityListQuery

Inherited from

EventQuery.addAuthors

---

addIds()

addIds(ids): CommunityListQuery

Defined in: core/EventQuery.ts:47

Parameters

ids

string[]

Returns

CommunityListQuery

Inherited from

EventQuery.addIds

---

addRoutes()

addRoutes(routes): CommunityListQuery

Defined in: core/EventQuery.ts:204

Adds routes alongside the rendered ones.

Parameters

routes

RelaySelection[]

Returns

CommunityListQuery

Inherited from

EventQuery.addRoutes

---

addTag()

addTag(key, values): CommunityListQuery

Defined in: core/EventQuery.ts:95

Parameters

key

string

values

string[]

Returns

CommunityListQuery

Inherited from

EventQuery.addTag

---

authorRoutes()

protected authorRoutes(weight): RelaySelection[]

Defined in: core/EventQuery.ts:258

Returns the outboxes of the authors being queried.

Parameters

weight

number = 1

Returns

RelaySelection[]

Inherited from

EventQuery.authorRoutes

---

clearAuthors()

clearAuthors(): CommunityListQuery

Defined in: core/EventQuery.ts:83

Returns

CommunityListQuery

Inherited from

EventQuery.clearAuthors

---

clearIds()

clearIds(): CommunityListQuery

Defined in: core/EventQuery.ts:59

Returns

CommunityListQuery

Inherited from

EventQuery.clearIds

---

clearLimit()

clearLimit(): CommunityListQuery

Defined in: core/EventQuery.ts:159

Returns

CommunityListQuery

Inherited from

EventQuery.clearLimit

---

clearRoom()

clearRoom(): CommunityListQuery

Defined in: core/EventQuery.ts:184

Returns

CommunityListQuery

Inherited from

EventQuery.clearRoom

---

clearRoutes()

clearRoutes(): CommunityListQuery

Defined in: core/EventQuery.ts:210

Returns

CommunityListQuery

Inherited from

EventQuery.clearRoutes

---

clearSearch()

clearSearch(): CommunityListQuery

Defined in: core/EventQuery.ts:171

Returns

CommunityListQuery

Inherited from

EventQuery.clearSearch

---

clearSince()

clearSince(): CommunityListQuery

Defined in: core/EventQuery.ts:135

Returns

CommunityListQuery

Inherited from

EventQuery.clearSince

---

clearTag()

clearTag(key): CommunityListQuery

Defined in: core/EventQuery.ts:117

Parameters

key

string

Returns

CommunityListQuery

Inherited from

EventQuery.clearTag

---

clearTags()

clearTags(): CommunityListQuery

Defined in: core/EventQuery.ts:123

Returns

CommunityListQuery

Inherited from

EventQuery.clearTags

---

clearUntil()

clearUntil(): CommunityListQuery

Defined in: core/EventQuery.ts:147

Returns

CommunityListQuery

Inherited from

EventQuery.clearUntil

---

mentionRoutes()

protected mentionRoutes(weight): RelaySelection[]

Defined in: core/EventQuery.ts:266

Returns the inboxes of the pubkeys this query filters on by p tag — where events addressed to them are delivered.

Parameters

weight

number = 0.5

Returns

RelaySelection[]

Inherited from

EventQuery.mentionRoutes

---

relays()

relays(): Promise<string[]>

Defined in: core/EventQuery.ts:290

Shortcut for getting relays from the router scenario.

Returns

Promise<string[]>

Inherited from

EventQuery.relays

---

removeAuthors()

removeAuthors(authors): CommunityListQuery

Defined in: core/EventQuery.ts:77

Parameters

authors

string[]

Returns

CommunityListQuery

Inherited from

EventQuery.removeAuthors

---

removeIds()

removeIds(ids): CommunityListQuery

Defined in: core/EventQuery.ts:53

Parameters

ids

string[]

Returns

CommunityListQuery

Inherited from

EventQuery.removeIds

---

removeTag()

removeTag(key, values): CommunityListQuery

Defined in: core/EventQuery.ts:106

Parameters

key

string

values

string[]

Returns

CommunityListQuery

Inherited from

EventQuery.removeTag

---

render()

render(): Promise<{ filters: Filter[]; relays: string[]; }>

Defined in: core/EventQuery.ts:297

Returns rendered filters along with the relays to request them from.

Returns

Promise<{ filters: Filter[]; relays: string[]; }>

Inherited from

EventQuery.render

---

renderBaseFilter()

protected renderBaseFilter(): MaybeAsync<Filter>

Defined in: core/EventQuery.ts:220

Returns the filter fields that may be set on any kind.

Returns

MaybeAsync<Filter>

Inherited from

EventQuery.renderBaseFilter

---

renderDomainFilters()

protected renderDomainFilters(): MaybeAsync<Filter[]>

Defined in: core/EventQuery.ts:241

Returns one filter per kind-specific variant. A relay ANDs a filter's fields together, so alternative references go in separate filters.

Returns

MaybeAsync<Filter[]>

Inherited from

EventQuery.renderDomainFilters

---

renderFilters()

renderFilters(): Promise<Filter[]>

Defined in: core/EventQuery.ts:248

Returns the complete filter list for requesting.

Returns

Promise<Filter[]>

Inherited from

EventQuery.renderFilters

---

renderRoutes()

protected renderRoutes(): RelaySelection[]

Defined in: kinds/CommunityList.ts:27

Returns the list of routes this query should be sent to. Every kind implements this itself; there is no default.

Returns

RelaySelection[]

Overrides

EventQuery.renderRoutes

---

scenario()

scenario(): Promise<RelayScenario>

Defined in: core/EventQuery.ts:281

Returns a router scenario for this query. Requests the routes given to setRoutes when set, otherwise the rendered ones; either way addRoutes contributes on top.

Returns

Promise<RelayScenario>

Inherited from

EventQuery.scenario

---

setAuthors()

setAuthors(authors): CommunityListQuery

Defined in: core/EventQuery.ts:65

Parameters

authors

string[]

Returns

CommunityListQuery

Inherited from

EventQuery.setAuthors

---

setIds()

setIds(ids): CommunityListQuery

Defined in: core/EventQuery.ts:41

Parameters

ids

string[]

Returns

CommunityListQuery

Inherited from

EventQuery.setIds

---

setLimit()

setLimit(limit): CommunityListQuery

Defined in: core/EventQuery.ts:153

Parameters

limit

number

Returns

CommunityListQuery

Inherited from

EventQuery.setLimit

---

setRoom()

setRoom(url, room): CommunityListQuery

Defined in: core/EventQuery.ts:178

Parameters

url

string

room

string

Returns

CommunityListQuery

Inherited from

EventQuery.setRoom

---

setRoutes()

setRoutes(routes): CommunityListQuery

Defined in: core/EventQuery.ts:195

Replaces the rendered routes. These are routes rather than urls, so setRoutes([userInbox()]) asks the user's read relays without resolving them first.

Parameters

routes

RelaySelection[]

Returns

CommunityListQuery

Inherited from

EventQuery.setRoutes

---

setSearch()

setSearch(search): CommunityListQuery

Defined in: core/EventQuery.ts:165

Parameters

search

string

Returns

CommunityListQuery

Inherited from

EventQuery.setSearch

---

setSince()

setSince(since): CommunityListQuery

Defined in: core/EventQuery.ts:129

Parameters

since

number

Returns

CommunityListQuery

Inherited from

EventQuery.setSince

---

setTag()

setTag(key, values): CommunityListQuery

Defined in: core/EventQuery.ts:89

Parameters

key

string

values

string[]

Returns

CommunityListQuery

Inherited from

EventQuery.setTag

---

setUntil()

setUntil(until): CommunityListQuery

Defined in: core/EventQuery.ts:141

Parameters

until

number

Returns

CommunityListQuery

Inherited from

EventQuery.setUntil