Skip to content

Welshman Docs / @welshman/app / Events

Class: Events

Defined in: app/src/plugins/events.ts:38

Reactive views over the app's repository. Every method binds this app's repository and tracker and hands back a Projection — read it synchronously with .get(), or subscribe to .$ — so callers never build one from the other, and never construct {repository, tracker} by hand.

Each projection supplies its own getter that queries the repository/tracker directly, rather than falling back to reading through the derived store. Those queries are index-backed; standing a derived store up and tearing it down just to read a value is not.

Constructors

Constructor

new Events(app): Events

Defined in: app/src/plugins/events.ts:39

Parameters

app

IApp

Returns

Events

Properties

app

readonly app: IApp

Defined in: app/src/plugins/events.ts:39

Methods

all()

all(filters): Projection<TrustedEvent[]>

Defined in: app/src/plugins/events.ts:47

Parameters

filters

Filter[] = ...

Returns

Projection<TrustedEvent[]>


asc()

asc(filters): Projection<TrustedEvent[]>

Defined in: app/src/plugins/events.ts:55

Parameters

filters

Filter[] = ...

Returns

Projection<TrustedEvent[]>


byId()

byId(filters): Projection<EventsById>

Defined in: app/src/plugins/events.ts:41

Parameters

filters

Filter[] = ...

Returns

Projection<EventsById>


byIdByUrl()

byIdByUrl(filters): Projection<EventsByIdByUrl>

Defined in: app/src/plugins/events.ts:103

Parameters

filters

Filter[] = ...

Returns

Projection<EventsByIdByUrl>


byIdForUrl()

byIdForUrl(url, filters): Projection<EventsById>

Defined in: app/src/plugins/events.ts:89

Parameters

url

string

filters

Filter[] = ...

Returns

Projection<EventsById>


desc()

desc(filters): Projection<TrustedEvent[]>

Defined in: app/src/plugins/events.ts:63

Parameters

filters

Filter[] = ...

Returns

Projection<TrustedEvent[]>


forUrl()

forUrl(url, filters): Projection<TrustedEvent[]>

Defined in: app/src/plugins/events.ts:95

Parameters

url

string

filters

Filter[] = ...

Returns

Projection<TrustedEvent[]>


isDeleted()

isDeleted(event): Projection<boolean>

Defined in: app/src/plugins/events.ts:82

Parameters

event

TrustedEvent

Returns

Projection<boolean>


one()

one(idOrAddress, relays): Projection<Maybe<TrustedEvent>>

Defined in: app/src/plugins/events.ts:71

Parameters

idOrAddress

string

relays

string[] = []

Returns

Projection<Maybe<TrustedEvent>>


relaySignedForUrl()

relaySignedForUrl(url, filters): Projection<TrustedEvent[]>

Defined in: app/src/plugins/events.ts:109

Parameters

url

string

filters

Filter[] = ...

Returns

Projection<TrustedEvent[]>