peer-devicer - v0.1.3
    Preparing search index...

    Interface AsyncPeerStorage

    Async peer graph storage contract. Implemented by the PostgreSQL and Redis adapters.

    interface AsyncPeerStorage {
        clearEdges(deviceId?: string): Promise<void>;
        close(): Promise<void>;
        findPeersBySignal(
            edgeType: PeerEdgeType,
            signalValue: string,
            limit?: number,
        ): Promise<string[]>;
        getDeviceCache(deviceId: string): Promise<PeerDeviceCache | null>;
        getEdges(deviceId: string, limit?: number): Promise<PeerEdge[]>;
        init(): Promise<void>;
        pruneStaleEdges(olderThanMs: number): Promise<number>;
        registerDeviceSignal(
            deviceId: string,
            edgeType: PeerEdgeType,
            signalValue: string,
        ): Promise<string[]>;
        saveDeviceCache(cache: PeerDeviceCache): Promise<void>;
        size(): Promise<number>;
        upsertEdge(edge: Omit<PeerEdge, "id">): Promise<PeerEdge>;
    }
    Index

    Methods

    • Parameters

      • OptionaldeviceId: string

      Returns Promise<void>

    • Parameters

      • edgeType: PeerEdgeType
      • signalValue: string
      • Optionallimit: number

      Returns Promise<string[]>

    • Parameters

      • deviceId: string
      • Optionallimit: number

      Returns Promise<PeerEdge[]>

    • Parameters

      • olderThanMs: number

      Returns Promise<number>

    • Parameters

      Returns Promise<string[]>