Interface AsyncIpStorage

Async version of the storage interface for adapters backed by network-based databases (PostgreSQL, Redis).

interface AsyncIpStorage {
    clear(deviceId?: string): Promise<void>;
    close(): Promise<void>;
    getHistory(deviceId: string, limit?: number): Promise<IpSnapshot[]>;
    getLatest(deviceId: string): Promise<IpSnapshot | null>;
    init(): Promise<void>;
    save(snapshot: Omit<IpSnapshot, "id">): Promise<IpSnapshot>;
    size(): Promise<number>;
}

Index

Methods

clear close getHistory getLatest init save size

Methods

clear

clear(deviceId?: string): Promise<void>
Delete snapshots — all devices if deviceId is omitted.
Parameters
- OptionaldeviceId: string
Returns Promise<void>
- Defined in libs/adapters/postgres.ts:19

close

close(): Promise<void>
Release connection pool / client.

Returns Promise<void>
- Defined in libs/adapters/postgres.ts:21

getHistory

getHistory(deviceId: string, limit?: number): Promise<IpSnapshot[]>
Return snapshots for a device, newest first.
Parameters
- deviceId: string
- Optionallimit: number
Returns Promise<IpSnapshot[]>
- Defined in libs/adapters/postgres.ts:15

getLatest

getLatest(deviceId: string): Promise<IpSnapshot | null>
Return the most-recent snapshot for a device, or null.
Parameters
- deviceId: string
Returns Promise<IpSnapshot | null>
- Defined in libs/adapters/postgres.ts:17

init

init(): Promise<void>
Initialise the store (create tables / indices if needed).

Returns Promise<void>
- Defined in libs/adapters/postgres.ts:11

save

save(snapshot: Omit<IpSnapshot, "id">): Promise<IpSnapshot>
Persist a snapshot and return the full record with its generated id.
Parameters
- snapshot: Omit<IpSnapshot, "id">
Returns Promise<IpSnapshot>
- Defined in libs/adapters/postgres.ts:13

size

size(): Promise<number>
Number of unique device IDs currently stored.

Returns Promise<number>
- Defined in libs/adapters/postgres.ts:23