Welshman

Appearance

Welshman Docs / @welshman/store / Repository

Interface: Repository ​

Defined in: packages/store/src/repository/core.ts:49

Where an app's events live. Reads are async; tracker and isDeleted are synchronous.

Properties ​

tracker ​

tracker: Tracker

Defined in: packages/store/src/repository/core.ts:50

Methods ​

clear() ​

clear(): Promise<void>

Defined in: packages/store/src/repository/core.ts:62

Returns ​

Promise<void>

count() ​

count(filters, options?): Promise<number>

Defined in: packages/store/src/repository/core.ts:52

Parameters ​

filters ​

Filter[]

options? ​

QueryOptions

Returns ​

Promise<number>

countTags() ​

countTags(name, options?): Promise<Map<string, number>>

Defined in: packages/store/src/repository/core.ts:54

How many visible events carry each value of the single-letter tag name.

Parameters ​

name ​

string

options? ​

CountTagsOptions

Returns ​

Promise<Map<string, number>>

getEvent() ​

getEvent(idOrAddress): Promise<Maybe<TrustedEvent>>

Defined in: packages/store/src/repository/core.ts:55

Parameters ​

idOrAddress ​

string

Returns ​

Promise<Maybe<TrustedEvent>>

isDeleted() ​

isDeleted(event): boolean

Defined in: packages/store/src/repository/core.ts:56

Parameters ​

event ​

TrustedEvent

Returns ​

boolean

observe() ​

observe(options): Unsubscriber

Defined in: packages/store/src/repository/core.ts:63

Parameters ​

options ​

ObserveOptions

Returns ​

Unsubscriber

off() ​

off<E>(event, listener): unknown

Defined in: packages/store/src/repository/core.ts:68

Type Parameters ​

E ​

E extends keyof RepositoryEvents

Parameters ​

event ​

E

listener ​

(...args) => void

Returns ​

unknown

on() ​

on<E>(event, listener): unknown

Defined in: packages/store/src/repository/core.ts:64

Type Parameters ​

E ​

E extends keyof RepositoryEvents

Parameters ​

event ​

E

listener ​

(...args) => void

Returns ​

unknown

pendingWrites() ​

pendingWrites(): Maybe<Promise<void>>

Defined in: packages/store/src/repository/core.ts:61

Settles once every write so far is reported, or is undefined when none is outstanding.

Returns ​

Maybe<Promise<void>>

publish() ​

publish(event): Promise<boolean>

Defined in: packages/store/src/repository/core.ts:58

Stores event, resolving whether a query would now return it.

Parameters ​

event ​

TrustedEvent

Returns ​

Promise<boolean>

query() ​

query(filters, options?): Promise<TrustedEvent[]>

Defined in: packages/store/src/repository/core.ts:51

Parameters ​

filters ​

Filter[]

options? ​

QueryOptions

Returns ​

Promise<TrustedEvent[]>

removeEvent() ​

removeEvent(idOrAddress): Promise<void>

Defined in: packages/store/src/repository/core.ts:59

Parameters ​

idOrAddress ​

string

Returns ​

Promise<void>