Skip to content

Latest commit

 

History

History
140 lines (83 loc) · 3.52 KB

object-graph.doc.md

File metadata and controls

140 lines (83 loc) · 3.52 KB

Object Graph

Constructor

ObjectGraph()

Returns an instance of ObjectGraph.

Parameters

Name Type Default Description
nodeValues Array<NodeValue> - Required. The array of objects to generate the nodes of the graph.
keyExtractor (nodeValue: NodeValue) => string - Required. The function to generate a key for each node.

Instance Properties

length

Returns the length of the object graph.

size

Returns the size of the object graph.

Instance Methods

keys()

Returns an iterator object that contains the keys of the object graph.

values()

Returns an iterator object that contains the values of the object graph.

get()

Returns a node of the object graph.

Parameters

Name Type Default Description
nodeKey string - Required. The key of the node to return from the object graph.

copy()

Returns a copy of the original object graph.

subgraph()

Returns a subgraph of the original object graph.

Parameters

Name Type Default Description
nodeKeys Array<string> - Required. The array of keys of the nodes to add to the object subgraph.

add()

Adds a node to the object graph.

Parameters

Name Type Default Description
nodeValue NodeValue - Required. The value of the node to add to the object graph.

toAdded()

Returns a copy of the original object graph with a received node added.

Parameters

Name Type Default Description
nodeValue NodeValue - Required. The value of the node to add to the object graph.

update()

Updates a node in the object graph.

Parameters

Name Type Default Description
nodeValue NodeValue - Required. The value of the node to update in the object graph.

toUpdated()

Returns a copy of the original object graph with a received node updated.

Parameters

Name Type Default Description
nodeValue NodeValue - Required. The value of the node to update in the object graph.

remove()

Removes a node from the object graph.

Parameters

Name Type Default Description
nodeKey string - Required. The key of the node to remove from the object graph.

toRemoved()

Returns a copy of the original object graph with a received node removed.

Parameters

Name Type Default Description
nodeKey string - Required. The key of the node to remove from the object graph.

valuesOf()

Returns a list of unique values for a specified property across selected nodes in the object graph. If no selection is made, it operates on the entire graph.

Parameters

Name Type Default Description
propertyKey keyof NodeValue - Required. The property key of the node values to return from the object graph.
nodeKeys Array<string> - The array of nodes keys to define the selected nodes.

match()

Returns all nodes that match with the provided shape.

Parameters

Name Type Default Description
shape Partial<Record<keyof NodeValue, Array<unknown>>> - Required. The shape of the nodes to return from the object graph.