Interface CacheServiceOptions

Options for creating a cache service.

Example

const cacheService = createCacheService({
  query: (filters) => myIndexedDB.query(filters),
  store: (event) => myIndexedDB.store(event),
  isAvailable: () => true,
});

interface CacheServiceOptions {
    isAvailable(): boolean;
    query(filters: NostrFilter[]): Promise<NostrEvent[]>;
    store(event: NostrEvent): void;
}

Index

Methods

isAvailable query store

Methods

isAvailable

isAvailable(): boolean
Whether the cache is available.

Returns boolean
true if the cache can handle requests
- Defined in packages/services/src/cache-service.ts:44

query

query(filters: NostrFilter[]): Promise<NostrEvent[]>
Query cached events matching the given filters.
Parameters
- filters: NostrFilter[]
  NIP-01 filter objects
Returns Promise<NostrEvent[]>
Promise resolving to matching cached events
- Defined in packages/services/src/cache-service.ts:30

store

store(event: NostrEvent): void
Store an event in cache. Best-effort, may silently fail.
Parameters
- event: NostrEvent
  The event to store
Returns void
- Defined in packages/services/src/cache-service.ts:37

Interface CacheServiceOptions

Example

Index

Methods

Methods

isAvailable

Returns boolean

query

Parameters

Returns Promise<NostrEvent[]>

store

Parameters

Returns void

Settings

On This Page