Class UserProfileCache

Dexie backed generic hookable store

Hierarchy (view full)

FeedCache<CachedMetadata>
- UserProfileCache

Constructors

constructor

new UserProfileCache(table?): UserProfileCache
Parameters
- Optional table: DexieTableLike<CachedMetadata, DexieIndexableType>
Returns UserProfileCache
Overrides FeedCache.constructor
- Defined in packages/system/src/cache/user-metadata.ts:8

Properties

`Private` #nip5Queue

#nip5Queue: {
nip05: string;
pubkey: string;
}[] = []

Type declaration

nip05: string
pubkey: string

`Private` #private

#private: any

`Private` #zapperQueue

#zapperQueue: {
lnurl: string;
pubkey: string;
}[] = []

Type declaration

lnurl: string
pubkey: string

`Protected` cache

cache: Map<string, CachedMetadata>

`Protected` log

log: Debugger

`Readonly` name

name: string

`Protected` onTable

onTable: Set<string>

`Protected` `Optional` table

table?: DexieTableLike<CachedMetadata, DexieIndexableType>

`Static` prefixed

prefixed: string | boolean

Methods

`Private` #batchQueue

#batchQueue<T>(queue, proc, batchSize?): Promise<void>
Type Parameters
- T
Parameters
- queue: T[]
- proc: ((v) => Promise<void>)
  - - (v): Promise<void>
    - Parameters
      v: T
      Returns Promise<void>
- batchSize: number = 3
Returns Promise<void>
- Defined in packages/system/src/cache/user-metadata.ts:125

`Private` #processNip5Queue

#processNip5Queue(): Promise<void>
Returns Promise<void>
- Defined in packages/system/src/cache/user-metadata.ts:105

`Private` #processZapperQueue

#processZapperQueue(): Promise<void>
Returns Promise<void>
- Defined in packages/system/src/cache/user-metadata.ts:85

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<CachedMetadata[]>
Parameters
- keys: string[]
Returns Promise<CachedMetadata[]>
Inherited from FeedCache.bulkGet
- Defined in packages/shared/dist/feed-cache.d.ts:28

bulkSet

bulkSet(obj): Promise<void>
Parameters
- obj: CachedMetadata[] | readonly CachedMetadata[]
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 | CachedMetadata>
Parameters
- Optional key: string
Returns Promise<undefined | CachedMetadata>
Inherited from FeedCache.get
- Defined in packages/shared/dist/feed-cache.d.ts:27

getFromCache

getFromCache(key?): undefined | CachedMetadata
Parameters
- Optional key: string
Returns undefined | CachedMetadata
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: CachedMetadata
Returns string
Overrides FeedCache.key
- Defined in packages/system/src/cache/user-metadata.ts:14

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

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-metadata.ts:18

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

search

search(q): Promise<CachedMetadata[]>
Parameters
- q: string
Returns Promise<CachedMetadata[]>
- Defined in packages/system/src/cache/user-metadata.ts:26

set

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

snapshot

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

takeSnapshot

takeSnapshot(): CachedMetadata[]
Returns CachedMetadata[]
Overrides FeedCache.takeSnapshot
- Defined in packages/system/src/cache/user-metadata.ts:81

update

update(m): Promise<"new" | "updated" | "refresh" | "no_change">
Try to update the profile metadata cache with a new version
Parameters
- m: CachedMetadata
  Profile metadata
Returns Promise<"new" | "updated" | "refresh" | "no_change">
Overrides FeedCache.update
- Defined in packages/system/src/cache/user-metadata.ts:61

Class UserProfileCache

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional table: DexieTableLike<CachedMetadata, DexieIndexableType>

Returns UserProfileCache

Properties

Private #nip5Queue

Type declaration

nip05: string

pubkey: string

Private #private

Private #zapperQueue

Type declaration

lnurl: string

pubkey: string

Protected cache

Protected log

Readonly name

Protected onTable

Protected Optional table

Static prefixed

Methods

Private #batchQueue

Type Parameters

T

Parameters

queue: T[]

proc: ((v) => Promise<void>)

Parameters

v: T

Returns Promise<void>

batchSize: number = 3

Returns Promise<void>

Private #processNip5Queue

Returns Promise<void>

Private #processZapperQueue

Returns Promise<void>

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<CachedMetadata[]>

bulkSet

Parameters

obj: CachedMetadata[] | readonly CachedMetadata[]

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

`Optional` table: DexieTableLike<CachedMetadata, DexieIndexableType>

`Private` #nip5Queue

`Private` #private

`Private` #zapperQueue

`Protected` cache

`Protected` log

`Readonly` name

`Protected` onTable

`Protected` `Optional` table

`Static` prefixed

`Private` #batchQueue

`Private` #processNip5Queue

`Private` #processZapperQueue

`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"