Function createUpdatedNodeUserData

  • 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

    Parameters

    • key: Key

      UserData entry key

    • vertex: Vertex

      Vertex of the node to modify

    • value: undefined | NodeUserDataEntries[Key]

      The value to set

    • Optional userDataInput: StringIndexedInterface

      If set, this object will be updated and returned. If unset, the associated node's UserData is queried, updated and returned.

    Returns StringIndexedInterface

Settings

Member Visibility

Theme

Generated using TypeDoc