Welshman

Appearance

Welshman Docs / @welshman/store

@welshman/store ​

Classes ​

Interfaces ​

Type Aliases ​

AsyncProjection ​

AsyncProjection<T> = Projection<T> & object

Defined in: packages/store/src/derive.ts:26

A Projection whose value comes from a Repository, with load for a fresh read.

Type Declaration ​

load ​

load: () => Promise<T>

Returns ​

Promise<T>

Type Parameters ​

T ​

T

ConnectSqliteOptions ​

ConnectSqliteOptions = object

Defined in: packages/store/src/repository/adapters/sqlite/leader.ts:14

Properties ​

createWorker ​

createWorker: () => Worker

Defined in: packages/store/src/repository/adapters/sqlite/leader.ts:17

Returns ​

Worker

name ​

name: string

Defined in: packages/store/src/repository/adapters/sqlite/leader.ts:15

CountTagsOptions ​

CountTagsOptions = Pick<QueryOptions, "signal">

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

DeleteChange ​

DeleteChange = ["add", string, DeleteRecord] | ["withdraw", string]

Defined in: packages/store/src/repository/adapters/sqlite/engine.ts:32

A change to the deletes, which a client mirroring DeleteIndex applies in order.

DeleteRecord ​

DeleteRecord = Pick<TrustedEvent, "id" | "pubkey" | "created_at">

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

EventOptions ​

EventOptions = object

Defined in: packages/store/src/derive.ts:151

Properties ​

includeDeleted? ​

optional includeDeleted?: boolean

Defined in: packages/store/src/derive.ts:153

onDerive? ​

optional onDerive?: (filters, ...args) => void

Defined in: packages/store/src/derive.ts:154

Parameters ​
filters ​

Filter[]

args ​

...any[]

Returns ​

void

repository ​

repository: Repository

Defined in: packages/store/src/derive.ts:152

EventsById ​

EventsById = Map<string, TrustedEvent>

Defined in: packages/store/src/derive.ts:45

EventsByIdByUrl ​

EventsByIdByUrl = Map<string, EventsById>

Defined in: packages/store/src/derive.ts:197

EventsByIdForUrlOptions ​

EventsByIdForUrlOptions = EventsByIdOptions & object

Defined in: packages/store/src/derive.ts:347

Type Declaration ​

url ​

url: string

EventsByIdOptions ​

EventsByIdOptions = object

Defined in: packages/store/src/derive.ts:47

Properties ​

filters ​

filters: Filter[]

Defined in: packages/store/src/derive.ts:48

includeDeleted? ​

optional includeDeleted?: boolean

Defined in: packages/store/src/derive.ts:50

repository ​

repository: Repository

Defined in: packages/store/src/derive.ts:49

EventToItem ​

EventToItem<T> = (event) => MaybeAsync<Maybe<T>>

Defined in: packages/store/src/derive.ts:475

Type Parameters ​

T ​

T

Parameters ​

event ​

TrustedEvent

Returns ​

MaybeAsync<Maybe<T>>

ExtendSqlite ​

ExtendSqlite<M> = (db, engine) => M

Defined in: packages/store/src/repository/adapters/sqlite/protocol.ts:24

Builds an app's methods after the engine migrates, so its schema can refer to the engine's.

Type Parameters ​

M ​

M extends SqliteExtension

Parameters ​

db ​

SqliteDatabase

engine ​

SqliteEngine

Returns ​

M

GetItem ​

GetItem<T> = (key, ...args) => MaybeAsync<Maybe<T>>

Defined in: packages/store/src/derive.ts:477

Type Parameters ​

T ​

T

Parameters ​

key ​

string

args ​

...any[]

Returns ​

MaybeAsync<Maybe<T>>

GetterOptions ​

GetterOptions<T> = object

Defined in: packages/store/src/misc.ts:8

Type Parameters ​

T ​

T

Properties ​

read? ​

optional read?: () => T

Defined in: packages/store/src/misc.ts:12

Returns ​

T

threshold? ​

optional threshold?: number

Defined in: packages/store/src/misc.ts:9

ItemCollection ​

ItemCollection<T> = Projection<ItemsByKey<T>> & object

Defined in: packages/store/src/derive.ts:480

Items keyed from events, with a read that waits out the query and parses still pending.

Type Declaration ​

read ​

read: (key) => MaybeAsync<Maybe<T>>

Parameters ​
key ​

string

Returns ​

MaybeAsync<Maybe<T>>

Type Parameters ​

T ​

T

ItemsByKey ​

ItemsByKey<T> = Map<string, T>

Defined in: packages/store/src/derive.ts:473

Type Parameters ​

T ​

T

ItemsByKeyByUrlOptions ​

ItemsByKeyByUrlOptions<T> = object

Defined in: packages/store/src/derive.ts:705

Type Parameters ​

T ​

T

Properties ​

eventToItem ​

eventToItem: EventToItem<T>

Defined in: packages/store/src/derive.ts:714

filters ​

filters: Filter[]

Defined in: packages/store/src/derive.ts:712

getKey ​

getKey: (item, url) => string | undefined

Defined in: packages/store/src/derive.ts:711

Parameters ​
item ​

T

url ​

string

Returns ​

string | undefined

includeDeleted? ​

optional includeDeleted?: boolean

Defined in: packages/store/src/derive.ts:715

repository ​

repository: Repository

Defined in: packages/store/src/derive.ts:713

revalidateOn? ​

optional revalidateOn?: Readable<unknown>

Defined in: packages/store/src/derive.ts:719

ItemsByKeyOptions ​

ItemsByKeyOptions<T> = object

Defined in: packages/store/src/derive.ts:601

Type Parameters ​

T ​

T

Properties ​

eventToItem ​

eventToItem: EventToItem<T>

Defined in: packages/store/src/derive.ts:605

filters ​

filters: Filter[]

Defined in: packages/store/src/derive.ts:603

getKey ​

getKey: (item) => string

Defined in: packages/store/src/derive.ts:602

Parameters ​
item ​

T

Returns ​

string

includeDeleted? ​

optional includeDeleted?: boolean

Defined in: packages/store/src/derive.ts:606

repository ​

repository: Repository

Defined in: packages/store/src/derive.ts:604

LoadItem ​

LoadItem = (key, ...args) => Promise<unknown>

Defined in: packages/store/src/derive.ts:954

Parameters ​

key ​

string

args ​

...any[]

Returns ​

Promise<unknown>

MakeLoadItemOptions ​

MakeLoadItemOptions = object

Defined in: packages/store/src/derive.ts:964

Properties ​

getFetched? ​

optional getFetched?: (key) => number

Defined in: packages/store/src/derive.ts:965

Parameters ​
key ​

string

Returns ​

number

getSource? ​

optional getSource?: (...args) => string

Defined in: packages/store/src/derive.ts:967

Parameters ​
args ​

...any[]

Returns ​

string

maxSize? ​

optional maxSize?: number

Defined in: packages/store/src/derive.ts:968

setFetched? ​

optional setFetched?: (key, ts) => void

Defined in: packages/store/src/derive.ts:966

Parameters ​
key ​

string

ts ​

number

Returns ​

void

timeout? ​

optional timeout?: number

Defined in: packages/store/src/derive.ts:969

ObserveEventsByIdOptions ​

ObserveEventsByIdOptions = EventsByIdOptions & object

Defined in: packages/store/src/derive.ts:103

Type Declaration ​

onEvents ​

onEvents: (eventsById) => void

Parameters ​
eventsById ​

EventsById

Returns ​

void

ObserveOptions ​

ObserveOptions = object

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

Properties ​

filters ​

filters: Filter[]

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

includeDeleted? ​

optional includeDeleted?: boolean

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

Also reports deleted events, and no removals.

onError? ​

optional onError?: (error) => void

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

Receives a read that fails. Without it, the failure is logged.

Parameters ​
error ​

unknown

Returns ​

void

onLoad? ​

optional onLoad?: (events) => void

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

Receives the read's events reconciled with changes made meanwhile, and again after a clear.

Parameters ​
events ​

TrustedEvent[]

Returns ​

void

onUpdate ​

onUpdate: (update) => void

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

Parameters ​
update ​

RepositoryUpdate

Returns ​

void

relay? ​

optional relay?: string

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

Only events the tracker has seen on this relay.

Projection ​

Projection<T> = ReadableWithGetter<T> & object

Defined in: packages/store/src/misc.ts:121

Utility type which allows for using the same value both for hot gets and derived subscriptions. It is a store itself, so derived(someProjection, ...) works as well as derived(someProjection.$, ...).

Type Declaration ​

$ ​

$: Readable<T>

Type Parameters ​

T ​

T

QueryOptions ​

QueryOptions = object

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

Properties ​

includeDeleted? ​

optional includeDeleted?: boolean

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

includeExpired? ​

optional includeExpired?: boolean

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

relay? ​

optional relay?: string

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

Only events the repository's tracker has seen on this relay, applied before any limit.

signal? ​

optional signal?: AbortSignal

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

Rejects the query with the signal's reason if it aborts before the repository answers.

QueryResult ​

QueryResult = object

Defined in: packages/store/src/repository/adapters/sqlite/engine.ts:44

Events as stored, with every relay each was seen on.

Properties ​

events ​

events: StoredEvent[]

Defined in: packages/store/src/repository/adapters/sqlite/engine.ts:45

relays ​

relays: [string, string[]][]

Defined in: packages/store/src/repository/adapters/sqlite/engine.ts:46

ReadableWithGetter ​

ReadableWithGetter<T> = Readable<T> & object

Defined in: packages/store/src/misc.ts:60

Type Declaration ​

get ​

get: () => T

Returns ​

T

Type Parameters ​

T ​

T

RepositoryEvents ​

RepositoryEvents = object

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

Properties ​

clear ​

clear: []

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

update ​

update: [RepositoryUpdate]

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

RepositoryUpdate ​

RepositoryUpdate = object

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

Properties ​

added ​

added: TrustedEvent[]

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

removed ​

removed: Set<string>

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

SqliteChange ​

SqliteChange = { ops: WriteOp[]; result: WriteResult; type: "write"; } | { type: "clear"; }

Defined in: packages/store/src/repository/adapters/sqlite/protocol.ts:41

A change a call committed to the database's events, which other connections hear about.

SqliteConnection ​

SqliteConnection<M> = object

Defined in: packages/store/src/repository/adapters/sqlite/protocol.ts:44

Calls the database in order, and hears other connections' changes in the order committed.

Type Parameters ​

M ​

M extends SqliteExtension = Record<never, never>

Properties ​

call ​

call: SqliteRpc<M>

Defined in: packages/store/src/repository/adapters/sqlite/protocol.ts:45

close ​

close: () => void

Defined in: packages/store/src/repository/adapters/sqlite/protocol.ts:47

Returns ​

void

subscribe ​

subscribe: (listener) => Unsubscriber

Defined in: packages/store/src/repository/adapters/sqlite/protocol.ts:46

Parameters ​
listener ​

(change) => void

Returns ​

Unsubscriber

SqliteExtension ​

SqliteExtension = Record<string, (...args) => unknown>

Defined in: packages/store/src/repository/adapters/sqlite/protocol.ts:21

Methods an app serves from the worker alongside the engine's, over the same database.

SqliteMethods ​

SqliteMethods = Pick<SqliteEngine, typeof SQLITE_ENGINE_METHODS[number]>

Defined in: packages/store/src/repository/adapters/sqlite/protocol.ts:18

SqliteOpen ​

SqliteOpen = object

Defined in: packages/store/src/repository/adapters/sqlite/protocol.ts:65

Sent to a worker first, naming the database it serves.

Properties ​

name ​

name: string

Defined in: packages/store/src/repository/adapters/sqlite/protocol.ts:67

type ​

type: "open"

Defined in: packages/store/src/repository/adapters/sqlite/protocol.ts:66

SqliteReply ​

SqliteReply = object

Defined in: packages/store/src/repository/adapters/sqlite/protocol.ts:59

A worker's answer to a request, with the change it committed, if any.

Properties ​

change? ​

optional change?: SqliteChange

Defined in: packages/store/src/repository/adapters/sqlite/protocol.ts:61

response ​

response: SqliteResponse

Defined in: packages/store/src/repository/adapters/sqlite/protocol.ts:60

SqliteRepositoryOptions ​

SqliteRepositoryOptions<M> = object

Defined in: packages/store/src/repository/adapters/sqlite/repository.ts:12

Type Parameters ​

M ​

M extends SqliteExtension = Record<never, never>

Properties ​

batchDelay? ​

optional batchDelay?: number

Defined in: packages/store/src/repository/adapters/sqlite/repository.ts:15

connection ​

connection: SqliteConnection<M>

Defined in: packages/store/src/repository/adapters/sqlite/repository.ts:13

SqliteRequest ​

SqliteRequest = object

Defined in: packages/store/src/repository/adapters/sqlite/protocol.ts:50

Properties ​

args ​

args: unknown[]

Defined in: packages/store/src/repository/adapters/sqlite/protocol.ts:53

id ​

id: string

Defined in: packages/store/src/repository/adapters/sqlite/protocol.ts:51

method ​

method: string

Defined in: packages/store/src/repository/adapters/sqlite/protocol.ts:52

SqliteResponse ​

SqliteResponse = { id: string; result: unknown; } | { error: string; id: string; }

Defined in: packages/store/src/repository/adapters/sqlite/protocol.ts:56

SqliteRpc ​

SqliteRpc<M> = <K>(method, ...args) => Promise<ReturnType<SqliteServed<M>[K]>>

Defined in: packages/store/src/repository/adapters/sqlite/protocol.ts:33

Calls a method wherever the database lives, in the order calls are made.

Type Parameters ​

M ​

M extends SqliteExtension = Record<never, never>

Type Parameters ​

K ​

K extends keyof SqliteServed<M> & string

Parameters ​

method ​

K

args ​

...Parameters<SqliteServed<M>[K]>

Returns ​

Promise<ReturnType<SqliteServed<M>[K]>>

SqliteServed ​

SqliteServed<M> = SqliteMethods & Omit<M, keyof SqliteMethods>

Defined in: packages/store/src/repository/adapters/sqlite/protocol.ts:30

The engine's methods and an extension's, which can't shadow them.

Type Parameters ​

M ​

M extends SqliteExtension

SqlValue ​

SqlValue = string | number | null | Uint8Array

Defined in: packages/store/src/repository/adapters/sqlite/engine.ts:7

StartStopNotifier ​

StartStopNotifier<T> = (set, update) => void | (() => void)

Defined in: packages/store/src/svelte.ts:9

Type Parameters ​

T ​

T

Parameters ​

set ​

(value) => void

update ​

(fn) => void

Returns ​

void | (() => void)

StoredEvent ​

StoredEvent = object

Defined in: packages/store/src/repository/adapters/sqlite/engine.ts:26

An event as stored, and whether its signature was checked before it was.

Properties ​

json ​

json: string

Defined in: packages/store/src/repository/adapters/sqlite/engine.ts:27

verified ​

verified: boolean

Defined in: packages/store/src/repository/adapters/sqlite/engine.ts:28

Stores ​

Stores = Readable<any> | [Readable<any>, ...Readable<any>[]] | Readable<any>[]

Defined in: packages/store/src/svelte.ts:23

StoresValues ​

StoresValues<T> = T extends Readable<infer U> ? U : { [K in keyof T]: T[K] extends Readable<infer U> ? U : never }

Defined in: packages/store/src/svelte.ts:25

Type Parameters ​

T ​

T

Subscriber ​

Subscriber<T> = (value) => void

Defined in: packages/store/src/svelte.ts:3

Type Parameters ​

T ​

T

Parameters ​

value ​

T

Returns ​

void

Synced ​

Synced<T> = Writable<T> & object

Defined in: packages/store/src/synced.ts:20

Type Declaration ​

ready ​

ready: Promise<void>

Type Parameters ​

T ​

T

Unsubscriber ​

Unsubscriber = () => void

Defined in: packages/store/src/svelte.ts:5

Returns ​

void

Updater ​

Updater<T> = (value) => T

Defined in: packages/store/src/svelte.ts:7

Type Parameters ​

T ​

T

Parameters ​

value ​

T

Returns ​

T

WritableWithGetter ​

WritableWithGetter<T> = Writable<T> & object

Defined in: packages/store/src/misc.ts:59

Type Declaration ​

get ​

get: () => T

Returns ​

T

Type Parameters ​

T ​

T

WriteOp ​

WriteOp = ["publish", TrustedEvent, boolean] | ["remove", string] | ["track", string, string] | ["untrack", string, string]

Defined in: packages/store/src/repository/adapters/sqlite/engine.ts:19

One step of a write batch. A publish carries whether its signature was checked.

WriteResult ​

WriteResult = object

Defined in: packages/store/src/repository/adapters/sqlite/engine.ts:35

What a batch changed, with restored carrying the events the caller didn't pass in.

Properties ​

added ​

added: string[]

Defined in: packages/store/src/repository/adapters/sqlite/engine.ts:36

deletes ​

deletes: DeleteChange[]

Defined in: packages/store/src/repository/adapters/sqlite/engine.ts:40

relays ​

relays: [string, string[]][]

Defined in: packages/store/src/repository/adapters/sqlite/engine.ts:38

removed ​

removed: string[]

Defined in: packages/store/src/repository/adapters/sqlite/engine.ts:39

restored ​

restored: StoredEvent[]

Defined in: packages/store/src/repository/adapters/sqlite/engine.ts:37

Variables ​

localStorageProvider ​

const localStorageProvider: StorageProvider

Defined in: packages/store/src/synced.ts:9

SQLITE_ENGINE_METHODS ​

const SQLITE_ENGINE_METHODS: readonly ["query", "count", "countTags", "getEvent", "getDeletes", "write", "evict", "prune", "clear"]

Defined in: packages/store/src/repository/adapters/sqlite/protocol.ts:6

The engine methods a worker serves, by name, so nothing else on the engine can be called.

Functions ​

connectSqlite() ​

connectSqlite<M>(__namedParameters): SqliteConnection<M>

Defined in: packages/store/src/repository/adapters/sqlite/leader.ts:43

Connect to sqlite database name through the tab that holds its lock and runs the worker.

Type Parameters ​

M ​

M extends SqliteExtension = Record<never, never>

Parameters ​

__namedParameters ​

ConnectSqliteOptions

Returns ​

SqliteConnection<M>

createSqliteHandler() ​

createSqliteHandler<M>(engine, extend?): (__namedParameters) => SqliteReply

Defined in: packages/store/src/repository/adapters/sqlite/protocol.ts:91

Migrates the engine, then answers requests for its methods and the extension's.

Type Parameters ​

M ​

M extends SqliteExtension

Parameters ​

engine ​

SqliteEngine

extend? ​

ExtendSqlite<M>

Returns ​

(__namedParameters) => SqliteReply

deriveArray() ​

deriveArray<T>(itemsById): Projection<T[]>

Defined in: packages/store/src/derive.ts:136

Type Parameters ​

T ​

T

Parameters ​

itemsById ​

Projection<Map<string, T>>

Returns ​

Projection<T[]>

derived() ​

Call Signature ​

derived<S, T>(stores, fn, initialValue?): Readable<T>

Defined in: packages/store/src/svelte.ts:98

Type Parameters ​
S ​

S extends Stores

T ​

T

Parameters ​
stores ​

S

fn ​

(values, set, update) => void | Unsubscriber

initialValue? ​

T

Returns ​

Readable<T>

Call Signature ​

derived<S, T>(stores, fn, initialValue?): Readable<T>

Defined in: packages/store/src/svelte.ts:107

Type Parameters ​
S ​

S extends Stores

T ​

T

Parameters ​
stores ​

S

fn ​

(values) => T

initialValue? ​

T

Returns ​

Readable<T>

deriveDeduplicated() ​

deriveDeduplicated<S, T>(stores, get): Readable<T>

Defined in: packages/store/src/misc.ts:82

Type Parameters ​

S ​

S extends Stores

T ​

T

Parameters ​

stores ​

S

get ​

(storeValues) => T

Returns ​

Readable<T>

deriveDeduplicatedByValue() ​

deriveDeduplicatedByValue<S, T>(stores, get): Readable<T>

Defined in: packages/store/src/misc.ts:98

Type Parameters ​

S ​

S extends Stores

T ​

T

Parameters ​

stores ​

S

get ​

(storeValues) => T

Returns ​

Readable<T>

deriveEvents() ​

deriveEvents(options): AsyncProjection<TrustedEvent[]>

Defined in: packages/store/src/derive.ts:148

Parameters ​

options ​

EventsByIdOptions

Returns ​

AsyncProjection<TrustedEvent[]>

deriveEventsArray() ​

deriveEventsArray(eventsById): AsyncProjection<TrustedEvent[]>

Defined in: packages/store/src/derive.ts:139

Parameters ​

eventsById ​

AsyncProjection<EventsById>

Returns ​

AsyncProjection<TrustedEvent[]>

deriveEventsAsc() ​

deriveEventsAsc(eventsById): AsyncProjection<TrustedEvent[]>

Defined in: packages/store/src/derive.ts:142

Parameters ​

eventsById ​

AsyncProjection<EventsById>

Returns ​

AsyncProjection<TrustedEvent[]>

deriveEventsById() ​

deriveEventsById(options): AsyncProjection<EventsById>

Defined in: packages/store/src/derive.ts:92

The events matching filters, kept current. It holds its last value until the read answers.

Parameters ​

options ​

EventsByIdOptions

Returns ​

AsyncProjection<EventsById>

deriveEventsByIdByUrl() ​

deriveEventsByIdByUrl(options): AsyncProjection<EventsByIdByUrl>

Defined in: packages/store/src/derive.ts:224

The events matching filters, grouped by each relay the tracker has seen them on.

Parameters ​

options ​

EventsByIdOptions

Returns ​

AsyncProjection<EventsByIdByUrl>

deriveEventsByIdForUrl() ​

deriveEventsByIdForUrl(options): AsyncProjection<EventsById>

Defined in: packages/store/src/derive.ts:366

Parameters ​

options ​

EventsByIdForUrlOptions

Returns ​

AsyncProjection<EventsById>

deriveEventsDesc() ​

deriveEventsDesc(eventsById): AsyncProjection<TrustedEvent[]>

Defined in: packages/store/src/derive.ts:145

Parameters ​

eventsById ​

AsyncProjection<EventsById>

Returns ​

AsyncProjection<TrustedEvent[]>

deriveIsDeleted() ​

deriveIsDeleted(repository, event): Projection<boolean>

Defined in: packages/store/src/derive.ts:1037

Parameters ​

repository ​

Repository

event ​

TrustedEvent

Returns ​

Projection<boolean>

deriveItems() ​

deriveItems<T>(itemsByKeyStore): Readable<T[]>

Defined in: packages/store/src/derive.ts:932

Type Parameters ​

T ​

T

Parameters ​

itemsByKeyStore ​

Readable<ItemsByKey<T>>

Returns ​

Readable<T[]>

deriveItemsByKey() ​

deriveItemsByKey<T>(__namedParameters): ItemCollection<T>

Defined in: packages/store/src/derive.ts:609

Type Parameters ​

T ​

T

Parameters ​

__namedParameters ​

ItemsByKeyOptions<T>

Returns ​

ItemCollection<T>

deriveItemsByKeyByUrl() ​

deriveItemsByKeyByUrl<T>(__namedParameters): ItemCollection<T>

Defined in: packages/store/src/derive.ts:723

Like deriveItemsByKey, but keying each event once per relay the tracker has seen it on.

Type Parameters ​

T ​

T

Parameters ​

__namedParameters ​

ItemsByKeyByUrlOptions<T>

Returns ​

ItemCollection<T>

deriveItemsSorted() ​

deriveItemsSorted<T>(sortFn, itemsStore): Readable<T[]>

Defined in: packages/store/src/derive.ts:935

Type Parameters ​

T ​

T

Parameters ​

sortFn ​

(item) => number

itemsStore ​

Readable<T[]>

Returns ​

Readable<T[]>

get() ​

get<T>(store): T

Defined in: packages/store/src/svelte.ts:173

Type Parameters ​

T ​

T

Parameters ​

store ​

Readable<T>

Returns ​

T

getEventsById() ​

getEventsById(__namedParameters): Promise<Map<string, TrustedEvent>>

Defined in: packages/store/src/derive.ts:53

Parameters ​

__namedParameters ​

EventsByIdOptions

Returns ​

Promise<Map<string, TrustedEvent>>

getEventsByIdByUrl() ​

getEventsByIdByUrl(__namedParameters): Promise<EventsByIdByUrl>

Defined in: packages/store/src/derive.ts:199

Parameters ​

__namedParameters ​

EventsByIdOptions

Returns ​

Promise<EventsByIdByUrl>

getEventsByIdForUrl() ​

getEventsByIdForUrl(__namedParameters): Promise<Map<string, TrustedEvent>>

Defined in: packages/store/src/derive.ts:352

The events one relay has been seen to hold, with any limit counting only those events.

Parameters ​

__namedParameters ​

EventsByIdForUrlOptions

Returns ​

Promise<Map<string, TrustedEvent>>

getter() ​

getter<T>(store, __namedParameters?): () => T

Defined in: packages/store/src/misc.ts:15

Type Parameters ​

T ​

T

Parameters ​

store ​

Readable<T>

__namedParameters? ​

GetterOptions<T> = {}

Returns ​

() => T

makeDeriveEvent() ​

makeDeriveEvent(__namedParameters): (idOrAddress, ...args) => AsyncProjection<Maybe<TrustedEvent>>

Defined in: packages/store/src/derive.ts:157

Parameters ​

__namedParameters ​

EventOptions

Returns ​

(idOrAddress, ...args) => AsyncProjection<Maybe<TrustedEvent>>

makeDeriveItem() ​

makeDeriveItem<T>(itemsByKeyStore, onDerive?): (key?, ...args) => Readable<T | undefined>

Defined in: packages/store/src/derive.ts:938

Type Parameters ​

T ​

T

Parameters ​

itemsByKeyStore ​

Readable<ItemsByKey<T>>

onDerive? ​

(key, ...args) => unknown

Returns ​

(key?, ...args) => Readable<T | undefined>

makeForceLoadItem() ​

makeForceLoadItem<T>(loadItem, getItem): (key, ...args) => Promise<Maybe<T>>

Defined in: packages/store/src/derive.ts:956

Type Parameters ​

T ​

T

Parameters ​

loadItem ​

LoadItem

getItem ​

GetItem<T>

Returns ​

(key, ...args) => Promise<Maybe<T>>

makeLoadItem() ​

makeLoadItem<T>(loadItem, getItem, options?): (key, ...args) => Promise<Maybe<T>>

Defined in: packages/store/src/derive.ts:972

Type Parameters ​

T ​

T

Parameters ​

loadItem ​

LoadItem

getItem ​

GetItem<T>

options? ​

MakeLoadItemOptions = {}

Returns ​

(key, ...args) => Promise<Maybe<T>>

memoized() ​

memoized<T>(store): object

Defined in: packages/store/src/misc.ts:66

Type Parameters ​

T ​

T

Parameters ​

store ​

Readable<T>

Returns ​

object

subscribe ​

subscribe: (f) => Unsubscriber

Parameters ​
f ​

Subscriber<T>

Returns ​

Unsubscriber

merged() ​

merged<S>(stores): Readable<StoresValues<S>>

Defined in: packages/store/src/misc.ts:114

Type Parameters ​

S ​

S extends Stores

Parameters ​

stores ​

S

Returns ​

Readable<StoresValues<S>>

mergeRepositoryUpdates() ​

mergeRepositoryUpdates(updates): RepositoryUpdate

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

Parameters ​

updates ​

RepositoryUpdate[]

Returns ​

RepositoryUpdate

observeEventsById() ​

observeEventsById(__namedParameters): Unsubscriber

Defined in: packages/store/src/derive.ts:108

Calls onEvents with the matches once the read answers, then on each change, until stopped.

Parameters ​

__namedParameters ​

ObserveEventsByIdOptions

Returns ​

Unsubscriber

observeRepository() ​

observeRepository(repository, __namedParameters): Unsubscriber

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

Reads the stored events matching filters, then reports each change until unsubscribed.

Parameters ​

repository ​

Repository

__namedParameters ​

ObserveOptions

Returns ​

Unsubscriber

projectAsync() ​

projectAsync<S, U>(src, read): AsyncProjection<U>

Defined in: packages/store/src/derive.ts:31

Build an AsyncProjection derived from another, whose load reads src fresh.

Type Parameters ​

S ​

S

U ​

U

Parameters ​

src ​

AsyncProjection<S>

read ​

($) => U

Returns ​

AsyncProjection<U>

projectFrom() ​

projectFrom<S, U>(src, read): Projection<U>

Defined in: packages/store/src/misc.ts:139

Build a Projection derived from another Projection: re-read src reactively via .$ or synchronously via .get().

Type Parameters ​

S ​

S

U ​

U

Parameters ​

src ​

Projection<S>

read ​

($) => U

Returns ​

Projection<U>

projection() ​

projection<T>($, read?): Projection<T>

Defined in: packages/store/src/misc.ts:129

Build a Projection from a readable store and an optional read function, which falls back to get($). On hot paths, the store value is cached, and read is skipped.

Type Parameters ​

T ​

T

Parameters ​

$ ​

Readable<T>

read? ​

() => T

Returns ​

Projection<T>

readable() ​

readable<T>(value?, start?): Readable<T>

Defined in: packages/store/src/svelte.ts:94

Type Parameters ​

T ​

T

Parameters ​

value? ​

T

start? ​

StartStopNotifier<T>

Returns ​

Readable<T>

readonly() ​

readonly<T>(store): Readable<T>

Defined in: packages/store/src/svelte.ts:171

Type Parameters ​

T ​

T

Parameters ​

store ​

Readable<T>

Returns ​

Readable<T>

sync() ​

sync<T>(__namedParameters): Promise<void>

Defined in: packages/store/src/synced.ts:22

Type Parameters ​

T ​

T

Parameters ​

__namedParameters ​

SyncConfig<T>

Returns ​

Promise<void>

synced() ​

synced<T>(__namedParameters): Synced<T>

Defined in: packages/store/src/synced.ts:40

Type Parameters ​

T ​

T

Parameters ​

__namedParameters ​

SyncedConfig<T>

Returns ​

Synced<T>

throttled() ​

throttled<T, S>(delay, store): S

Defined in: packages/store/src/misc.ts:72

Type Parameters ​

T ​

T

S ​

S extends Readable<T>

Parameters ​

delay ​

number

store ​

S

Returns ​

S

withGetter() ​

withGetter<S>(store): S & object

Defined in: packages/store/src/misc.ts:63

Type Parameters ​

S ​

S extends Readable<any>

Parameters ​

store ​

S

Returns ​

S & object

writable() ​

writable<T>(value?, start?): Writable<T>

Defined in: packages/store/src/svelte.ts:39

Type Parameters ​

T ​

T

Parameters ​

value? ​

T

start? ​

StartStopNotifier<T> = noop

Returns ​

Writable<T>