Class UserRelaysCache

Dexie backed generic hookable store

Hierarchy (view full)

FeedCache<UsersRelays>
- UserRelaysCache

Index

Constructors

constructor

Properties

#private cache log name onTable table? prefixed

Constructors

constructor

new UserRelaysCache(table?): UserRelaysCache
Parameters
- Optional table: DexieTableLike<UsersRelays, DexieIndexableType>
Returns UserRelaysCache
Overrides FeedCache.constructor
- Defined in packages/system/src/cache/user-relays.ts:5

Properties

`Private` #private

#private: any

`Protected` cache

cache: Map<string, UsersRelays>

`Protected` log

log: Debugger

`Readonly` name

name: string

`Protected` onTable

onTable: Set<string>

`Protected` `Optional` table

table?: DexieTableLike<UsersRelays, DexieIndexableType>

`Static` prefixed

prefixed: string | boolean

Methods

addListener

addListener<T>(event, fn, context?): this
Type Parameters
- T extends "change"
Parameters
- event: T
- fn: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: ArgumentMap<FeedCacheEvents>[Extract<T, "change">]
      Returns void
- Optional context: any
Returns this
Inherited from FeedCache.addListener
- Defined in .yarn/cache/eventemitter3-npm-5.0.1-5e423b7df3-543d6c858a.zip/node_modules/eventemitter3/index.d.ts:45

buffer

buffer(keys): Promise<string[]>
Loads a list of rows from disk cache
Parameters
- keys: string[]
  List of ids to load
Returns Promise<string[]>
Keys that do not exist on disk cache
Inherited from FeedCache.buffer
- Defined in packages/shared/dist/feed-cache.d.ts:45

bulkGet

bulkGet(keys): Promise<UsersRelays[]>
Parameters
- keys: string[]
Returns Promise<UsersRelays[]>
Inherited from FeedCache.bulkGet
- Defined in packages/shared/dist/feed-cache.d.ts:28

bulkSet

bulkSet(obj): Promise<void>
Parameters
- obj: UsersRelays[] | readonly UsersRelays[]
Returns Promise<void>
Inherited from FeedCache.bulkSet
- Defined in packages/shared/dist/feed-cache.d.ts:30

clear

clear(): Promise<void>
Returns Promise<void>
Inherited from FeedCache.clear
- Defined in packages/shared/dist/feed-cache.d.ts:46

emit

emit<T>(event, ...args): boolean
Calls each of the listeners registered for a given event.
Type Parameters
- T extends "change"
Parameters
- event: T
- Rest ...args: ArgumentMap<FeedCacheEvents>[Extract<T, "change">]
Returns boolean
Inherited from FeedCache.emit
- Defined in .yarn/cache/eventemitter3-npm-5.0.1-5e423b7df3-543d6c858a.zip/node_modules/eventemitter3/index.d.ts:32

eventNames

eventNames(): "change"[]
Return an array listing the events for which the emitter has registered listeners.

Returns "change"[]
Inherited from FeedCache.eventNames
- Defined in .yarn/cache/eventemitter3-npm-5.0.1-5e423b7df3-543d6c858a.zip/node_modules/eventemitter3/index.d.ts:15

get

get(key?): Promise<undefined | UsersRelays>
Parameters
- Optional key: string
Returns Promise<undefined | UsersRelays>
Inherited from FeedCache.get
- Defined in packages/shared/dist/feed-cache.d.ts:27

getFromCache

getFromCache(key?): undefined | UsersRelays
Parameters
- Optional key: string
Returns undefined | UsersRelays
Inherited from FeedCache.getFromCache
- Defined in packages/shared/dist/feed-cache.d.ts:26

hook

hook(fn, key): (() => this)
Parameters
- fn: HookFn
- key: undefined | string
Returns (() => this)
- - (): this
  - Returns this
Inherited from FeedCache.hook
- Defined in packages/shared/dist/feed-cache.d.ts:24

key

key(of): string
Parameters
- of: UsersRelays
Returns string
Overrides FeedCache.key
- Defined in packages/system/src/cache/user-relays.ts:9

keysOnTable

keysOnTable(): string[]
Returns string[]
Inherited from FeedCache.keysOnTable
- Defined in packages/shared/dist/feed-cache.d.ts:25

listenerCount

listenerCount(event): number
Return the number of listeners listening to a given event.
Parameters
- event: "change"
Returns number
Inherited from FeedCache.listenerCount
- Defined in .yarn/cache/eventemitter3-npm-5.0.1-5e423b7df3-543d6c858a.zip/node_modules/eventemitter3/index.d.ts:27

listeners

listeners<T>(event): ((...args) => void)[]
Return the listeners registered for a given event.
Type Parameters
- T extends "change"
Parameters
- event: T
Returns ((...args) => void)[]
Inherited from FeedCache.listeners
- Defined in .yarn/cache/eventemitter3-npm-5.0.1-5e423b7df3-543d6c858a.zip/node_modules/eventemitter3/index.d.ts:20

newest

newest(): number
Returns number
- Defined in packages/system/src/cache/user-relays.ts:20

off

off<T>(event, fn?, context?, once?): this
Type Parameters
- T extends "change"
Parameters
- event: T
- Optional fn: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: ArgumentMap<FeedCacheEvents>[Extract<T, "change">]
      Returns void
- Optional context: any
- Optional once: boolean
Returns this
Inherited from FeedCache.off
- Defined in .yarn/cache/eventemitter3-npm-5.0.1-5e423b7df3-543d6c858a.zip/node_modules/eventemitter3/index.d.ts:69

on

on<T>(event, fn, context?): this
Add a listener for a given event.
Type Parameters
- T extends "change"
Parameters
- event: T
- fn: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: ArgumentMap<FeedCacheEvents>[Extract<T, "change">]
      Returns void
- Optional context: any
Returns this
Inherited from FeedCache.on
- Defined in .yarn/cache/eventemitter3-npm-5.0.1-5e423b7df3-543d6c858a.zip/node_modules/eventemitter3/index.d.ts:40

once

once<T>(event, fn, context?): this
Add a one-time listener for a given event.
Type Parameters
- T extends "change"
Parameters
- event: T
- fn: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: ArgumentMap<FeedCacheEvents>[Extract<T, "change">]
      Returns void
- Optional context: any
Returns this
Inherited from FeedCache.once
- Defined in .yarn/cache/eventemitter3-npm-5.0.1-5e423b7df3-543d6c858a.zip/node_modules/eventemitter3/index.d.ts:54

preload

preload(follows?): Promise<void>
Parameters
- Optional follows: string[]
Returns Promise<void>
Overrides FeedCache.preload
- Defined in packages/system/src/cache/user-relays.ts:13

removeAllListeners

removeAllListeners(event?): this
Remove all listeners, or those of the specified event.
Parameters
- Optional event: "change"
Returns this
Inherited from FeedCache.removeAllListeners
- Defined in .yarn/cache/eventemitter3-npm-5.0.1-5e423b7df3-543d6c858a.zip/node_modules/eventemitter3/index.d.ts:79

removeListener

removeListener<T>(event, fn?, context?, once?): this
Remove the listeners of a given event.
Type Parameters
- T extends "change"
Parameters
- event: T
- Optional fn: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: ArgumentMap<FeedCacheEvents>[Extract<T, "change">]
      Returns void
- Optional context: any
- Optional once: boolean
Returns this
Inherited from FeedCache.removeListener
- Defined in .yarn/cache/eventemitter3-npm-5.0.1-5e423b7df3-543d6c858a.zip/node_modules/eventemitter3/index.d.ts:63

set

set(obj): Promise<void>
Parameters
- obj: UsersRelays
Returns Promise<void>
Inherited from FeedCache.set
- Defined in packages/shared/dist/feed-cache.d.ts:29

snapshot

snapshot(): UsersRelays[]
Returns UsersRelays[]
Inherited from FeedCache.snapshot
- Defined in packages/shared/dist/feed-cache.d.ts:47

takeSnapshot

takeSnapshot(): UsersRelays[]
Returns UsersRelays[]
Overrides FeedCache.takeSnapshot
- Defined in packages/system/src/cache/user-relays.ts:26

update

update<TCachedWithCreated>(m): Promise<"new" | "updated" | "refresh" | "no_change">
Try to update an entry where created values exists
Type Parameters
- TCachedWithCreated extends UsersRelays & {
  created: number;
  loaded: number;
  }
Parameters
- m: TCachedWithCreated
  Profile metadata
Returns Promise<"new" | "updated" | "refresh" | "no_change">
Inherited from FeedCache.update
- Defined in packages/shared/dist/feed-cache.d.ts:36

Class UserRelaysCache

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional table: DexieTableLike<UsersRelays, DexieIndexableType>

Returns UserRelaysCache

Properties

Private #private

Protected cache

Protected log

Readonly name

Protected onTable

Protected Optional table

Static prefixed

Methods

addListener

Type Parameters

T extends "change"

Parameters

event: T

fn: ((...args) => void)

Parameters

Rest ...args: ArgumentMap<FeedCacheEvents>[Extract<T, "change">]

Returns void

Optional context: any

Returns this

buffer

Parameters

keys: string[]

Returns Promise<string[]>

bulkGet

Parameters

keys: string[]

Returns Promise<UsersRelays[]>

bulkSet

Parameters

obj: UsersRelays[] | readonly UsersRelays[]

Returns Promise<void>

clear

Returns Promise<void>

emit

Type Parameters

T extends "change"

Parameters

event: T

Rest ...args: ArgumentMap<FeedCacheEvents>[Extract<T, "change">]

Returns boolean

eventNames

Returns "change"[]

get

Parameters

Optional key: string

Returns Promise<undefined | UsersRelays>

getFromCache

Parameters

Optional key: string

Returns undefined | UsersRelays

hook

Parameters

fn: HookFn

key: undefined | string

Returns (() => this)

Returns this

key

Parameters

of: UsersRelays

Returns string

keysOnTable

Returns string[]

listenerCount

Parameters

event: "change"

Returns number

listeners

Type Parameters

`Optional` table: DexieTableLike<UsersRelays, DexieIndexableType>

`Private` #private

`Protected` cache

`Protected` log

`Readonly` name

`Protected` onTable

`Protected` `Optional` table

`Static` prefixed

`Rest` ...args: ArgumentMap<FeedCacheEvents>[Extract<T, "change">]

`Optional` context: any

`Rest` ...args: ArgumentMap<FeedCacheEvents>[Extract<T, "change">]

`Optional` key: string

`Optional` key: string

`Optional` fn: ((...args) => void)

`Rest` ...args: ArgumentMap<FeedCacheEvents>[Extract<T, "change">]

`Optional` context: any

`Optional` once: boolean

`Rest` ...args: ArgumentMap<FeedCacheEvents>[Extract<T, "change">]

`Optional` context: any

`Rest` ...args: ArgumentMap<FeedCacheEvents>[Extract<T, "change">]

`Optional` context: any

`Optional` follows: string[]

`Optional` event: "change"

`Optional` fn: ((...args) => void)

`Rest` ...args: ArgumentMap<FeedCacheEvents>[Extract<T, "change">]

`Optional` context: any

`Optional` once: boolean