Skip to content

Function: useEdgesData

useEdgesData<EdgeType>(edgeId): ComputedRef<EdgeData<EdgeType> | null>

Composable for receiving data of one or multiple nodes

Type parameters

NameType
EdgeTypeextends Edge = GraphEdge

Parameters

NameTypeDescription
edgeIdMaybeRefOrGetter<string>The id (or ids) of the node to get the data from

Returns

ComputedRef<EdgeData<EdgeType> | null>

An array of data objects

useEdgesData<EdgeType>(edgeIds): ComputedRef<EdgeData<EdgeType>[]>

Type parameters

NameType
EdgeTypeextends Edge = GraphEdge

Parameters

NameType
edgeIdsMaybeRefOrGetter<string[]>

Returns

ComputedRef<EdgeData<EdgeType>[]>

useEdgesData<EdgeType>(edgeIds, guard): ComputedRef<EdgeData<EdgeType>[]>

Type parameters

NameType
EdgeTypeextends Edge = GraphEdge

Parameters

NameType
edgeIdsMaybeRefOrGetter<string[]>
guard(node: Edge) => node is EdgeType

Returns

ComputedRef<EdgeData<EdgeType>[]>

Released under the MIT License.