Function createUpdatedNodeUserData

createUpdatedNodeUserData<Key>(key: Key, vertex: Vertex, value: NodeUserDataEntries[Key], userData?: StringIndexedInterface): StringIndexedInterface
Create new UserData for given key and vertex

Returns
Updated UserData object

Note: If UserData entry is incompatible to vertex an error is thrown. Note: This function does not change the underlying graph
Type Parameters
Type Parameters
- Key extends keyof NodeUserDataEntries
Parameters
- key: Key
  
  UserData entry key
- vertex: Vertex
  
  Vertex of the node to modify
- value: NodeUserDataEntries[Key]
  
  The value to set
- Optional userData: StringIndexedInterface
  
  If set, this object will be updated and returned. If unset, the associated node's UserData is queried, updated and returned.
Returns StringIndexedInterface
- Defined in ts_lib/lib/userdata_utils.ts:92

Generated using TypeDoc