Class FeedCache<TCached>`Abstract`

Dexie backed generic hookable store

Type Parameters

TCached

Hierarchy

EventEmitter<FeedCacheEvents>
- FeedCache

Index

Constructors

constructor

Properties

#hits #miss #snapshot cache log name onTable table? prefixed

Constructors

constructor

new FeedCache<TCached>(name, table?): FeedCache<TCached>
Type Parameters
- TCached
Parameters
- name: string
- Optional table: DexieTableLike<TCached, DexieIndexableType>
Returns FeedCache<TCached>
Overrides EventEmitter<FeedCacheEvents>.constructor
- Defined in packages/shared/src/feed-cache.ts:30

Properties

`Private` #hits

#hits: number = 0

`Private` #miss

#miss: number = 0

`Private` #snapshot

#snapshot: TCached[] = []

`Protected` cache

cache: Map<string, TCached> = ...

`Protected` log

log: Debugger

`Readonly` name

name: string

`Protected` onTable

onTable: Set<string> = ...

`Protected` `Optional` table

table?: DexieTableLike<TCached, 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 EventEmitter.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
- Defined in packages/shared/src/feed-cache.ts:174

bulkGet

bulkGet(keys): Promise<TCached[]>
Parameters
- keys: string[]
Returns Promise<TCached[]>
- Defined in packages/shared/src/feed-cache.ts:95

bulkSet

bulkSet(obj): Promise<void>
Parameters
- obj: TCached[] | readonly TCached[]
Returns Promise<void>
- Defined in packages/shared/src/feed-cache.ts:122

clear

clear(): Promise<void>
Returns Promise<void>
- Defined in packages/shared/src/feed-cache.ts:198

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 EventEmitter.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 EventEmitter.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 | TCached>
Parameters
- Optional key: string
Returns Promise<undefined | TCached>
- Defined in packages/shared/src/feed-cache.ts:83

getFromCache

getFromCache(key?): undefined | TCached
Parameters
- Optional key: string
Returns undefined | TCached
- Defined in packages/shared/src/feed-cache.ts:71

hook

hook(fn, key): (() => FeedCache<TCached>)
Parameters
- fn: HookFn
- key: undefined | string
Returns (() => FeedCache<TCached>)
- - (): FeedCache<TCached>
  - Returns FeedCache<TCached>
- Defined in packages/shared/src/feed-cache.ts:57

`Abstract` key

key(of): string
Parameters
- of: TCached
Returns string
- Defined in packages/shared/src/feed-cache.ts:208

keysOnTable

keysOnTable(): string[]
Returns string[]
- Defined in packages/shared/src/feed-cache.ts:67

listenerCount

listenerCount(event): number
Return the number of listeners listening to a given event.
Parameters
- event: "change"
Returns number
Inherited from EventEmitter.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 EventEmitter.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 EventEmitter.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 EventEmitter.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 EventEmitter.once
- Defined in .yarn/cache/eventemitter3-npm-5.0.1-5e423b7df3-543d6c858a.zip/node_modules/eventemitter3/index.d.ts:54

preload

preload(): Promise<void>
Returns Promise<void>
- Defined in packages/shared/src/feed-cache.ts:49

removeAllListeners

removeAllListeners(event?): this
Remove all listeners, or those of the specified event.
Parameters
- Optional event: "change"
Returns this
Inherited from EventEmitter.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 EventEmitter.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: TCached
Returns Promise<void>
- Defined in packages/shared/src/feed-cache.ts:108

snapshot

snapshot(): TCached[]
Returns TCached[]
- Defined in packages/shared/src/feed-cache.ts:204

`Abstract` takeSnapshot

takeSnapshot(): TCached[]
Returns TCached[]
- Defined in packages/shared/src/feed-cache.ts:209

update

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

Class FeedCache<TCached>Abstract

Type Parameters

TCached

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

TCached

Parameters

name: string

Optional table: DexieTableLike<TCached, DexieIndexableType>

Returns FeedCache<TCached>

Properties

Private #hits

Private #miss

Private #snapshot

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

bulkSet

Parameters

obj: TCached[] | readonly TCached[]

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 | TCached>

getFromCache

Parameters

Optional key: string

Returns undefined | TCached

hook

Parameters

fn: HookFn

key: undefined | string

Returns (() => FeedCache<TCached>)

Returns FeedCache<TCached>

Abstract key

Parameters

of: TCached

Returns string

keysOnTable

Class FeedCache<TCached>`Abstract`

`Optional` table: DexieTableLike<TCached, DexieIndexableType>

`Private` #hits

`Private` #miss

`Private` #snapshot

`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

`Abstract` key

`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` event: "change"

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

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

`Optional` context: any

`Optional` once: boolean

`Abstract` takeSnapshot