peer-devicer - v0.1.3
Preparing search index...
AsyncPeerStorage
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
clear
Edges
close
find
Peers
By
Signal
get
Device
Cache
get
Edges
init
prune
Stale
Edges
register
Device
Signal
save
Device
Cache
size
upsert
Edge
Methods
clear
Edges
clearEdges
(
deviceId
?:
string
)
:
Promise
<
void
>
Parameters
Optional
deviceId
:
string
Returns
Promise
<
void
>
close
close
()
:
Promise
<
void
>
Returns
Promise
<
void
>
find
Peers
By
Signal
findPeersBySignal
(
edgeType
:
PeerEdgeType
,
signalValue
:
string
,
limit
?:
number
,
)
:
Promise
<
string
[]
>
Parameters
edgeType
:
PeerEdgeType
signalValue
:
string
Optional
limit
:
number
Returns
Promise
<
string
[]
>
get
Device
Cache
getDeviceCache
(
deviceId
:
string
)
:
Promise
<
PeerDeviceCache
|
null
>
Parameters
deviceId
:
string
Returns
Promise
<
PeerDeviceCache
|
null
>
get
Edges
getEdges
(
deviceId
:
string
,
limit
?:
number
)
:
Promise
<
PeerEdge
[]
>
Parameters
deviceId
:
string
Optional
limit
:
number
Returns
Promise
<
PeerEdge
[]
>
init
init
()
:
Promise
<
void
>
Returns
Promise
<
void
>
prune
Stale
Edges
pruneStaleEdges
(
olderThanMs
:
number
)
:
Promise
<
number
>
Parameters
olderThanMs
:
number
Returns
Promise
<
number
>
register
Device
Signal
registerDeviceSignal
(
deviceId
:
string
,
edgeType
:
PeerEdgeType
,
signalValue
:
string
,
)
:
Promise
<
string
[]
>
Parameters
deviceId
:
string
edgeType
:
PeerEdgeType
signalValue
:
string
Returns
Promise
<
string
[]
>
save
Device
Cache
saveDeviceCache
(
cache
:
PeerDeviceCache
)
:
Promise
<
void
>
Parameters
cache
:
PeerDeviceCache
Returns
Promise
<
void
>
size
size
()
:
Promise
<
number
>
Returns
Promise
<
number
>
upsert
Edge
upsertEdge
(
edge
:
Omit
<
PeerEdge
,
"id"
>
)
:
Promise
<
PeerEdge
>
Parameters
edge
:
Omit
<
PeerEdge
,
"id"
>
Returns
Promise
<
PeerEdge
>
Settings
Member Visibility
Inherited
External
Theme
OS
Light
Dark
On This Page
Methods
clear
Edges
close
find
Peers
By
Signal
get
Device
Cache
get
Edges
init
prune
Stale
Edges
register
Device
Signal
save
Device
Cache
size
upsert
Edge
peer-devicer - v0.1.3
Loading...
Async peer graph storage contract. Implemented by the PostgreSQL and Redis adapters.