Interface GroupMetadataCache

Group metadata cache — TTL-LRU + event-driven invalidation.

interface GroupMetadataCache {
    stats: {
        hits: number;
        invalidations: number;
        misses: number;
        size: number;
    };
    bind(sock: unknown): () => void;
    cachedGroupMetadata(jid: string): Promise<unknown>;
    clear(): void;
    get(jid: string): unknown;
    invalidate(jid: string): boolean;
    set(jid: string, metadata: unknown): void;
    unbind(): void;
}

Index

Properties

Methods

bind cachedGroupMetadata clear get invalidate set unbind

Properties

`Readonly`stats

stats: { hits: number; invalidations: number; misses: number; size: number }

Methods

bind

bind(sock: unknown): () => void
Wire fetching + auto-invalidation (groups.update / participants).
Parameters
- sock: unknown
Returns () => void
- Defined in lib/Utils/group-cache.d.ts:7

cachedGroupMetadata

cachedGroupMetadata(jid: string): Promise<unknown>
Pass this as cachedGroupMetadata in the socket config.
Parameters
- jid: string
Returns Promise<unknown>
- Defined in lib/Utils/group-cache.d.ts:5

clear

clear(): void
Returns void
- Defined in lib/Utils/group-cache.d.ts:14

get

get(jid: string): unknown
Fresh cached metadata, or null.
Parameters
- jid: string
Returns unknown
- Defined in lib/Utils/group-cache.d.ts:12

invalidate

invalidate(jid: string): boolean
Parameters
- jid: string
Returns boolean
- Defined in lib/Utils/group-cache.d.ts:13

set

set(jid: string, metadata: unknown): void
Seed manually after your own groupMetadata calls.
Parameters
- jid: string
- metadata: unknown
Returns void
- Defined in lib/Utils/group-cache.d.ts:10

unbind

unbind(): void
Returns void
- Defined in lib/Utils/group-cache.d.ts:8