Function getNodeUserDataEntryOrThrow

getNodeUserDataEntryOrThrow<Key>(key: Key, vertex: Vertex, userData?: StringIndexedInterface): NodeUserDataEntries[Key]
Get UserData entry for given key and vertex.

Returns
Value for the UserData key

Note: If UserData entry is incompatible to vertex an error is thrown. Note: If UserData entry is not available for vertex an error is thrown.
Type Parameters
Type Parameters
- Key extends keyof NodeUserDataEntries
Parameters
- key: Key
  
  UserData entry key
- vertex: Vertex
  
  Vertex of the node to access
- Optional userData: StringIndexedInterface
Returns NodeUserDataEntries[Key]
- Defined in ts_lib/lib/userdata_utils.ts:75

Generated using TypeDoc