Graph - Documentation

Constructor

new Graph(collection, fields, configopt)

import { Graph } from 'ancient-graph';

Source:

graph.js, line 20

Parameters:

Name Type Attributes Description

collection

A pointer to the collection dannymineobhodimye daapteru to work with the graph. This may be a connection to the SQL database and table name, for example, or a collection of Mongo.

fields

Object.<string, string>

Comparison of the data in the collection of data in the graph. It is necessary for the adapter.

config

Object

Additional config.

Name Type Attributes Description

aliases

Object

Name	Type	Attributes	Description
`$`	`String`	<optional>

Methods

count(selector, optionsopt, callbackopt) → {number}

Should count all matching documents.

Source:

graph.js, line 227

Parameters:

Name	Type	Attributes
`selector`	`string` \| `LinkSelector`
`options`	`SelectOptions`	<optional>
`callback`	`Graph~countCallback`	<optional>

Returns:

Type:: number

[count]

each(selector, optionsopt, callbackopt)

Should call callback once for each matching document, sequentially and synchronously.

Source:

graph.js, line 196

Parameters:

Name	Type	Attributes
`selector`	`string` \| `LinkSelector`
`options`	`SelectOptions`	<optional>
`callback`	`Graph~eachCallback`	<optional>

fetch(selector, optionsopt, callbackopt) → {Array.<Link>}

Find and all matching links as an Array.

Source:

graph.js, line 161

Parameters:

Name	Type	Attributes
`selector`	`string` \| `LinkSelector`
`options`	`SelectOptions`	<optional>
`callback`	`Graph~fetchCallback`	<optional>

Returns:

Type:: Array.<Link>

links - result links objects in array

get(selector, optionsopt, callbackopt) → {Link}

Get one first matching link.

Source:

graph.js, line 179

Parameters:

Name	Type	Attributes
`selector`	`string` \| `LinkSelector`
`options`	`SelectOptions`	<optional>
`callback`	`Graph~getCallback`	<optional>

Returns:

Type:: Link

link - result link object

insert(link, callbackopt, contextopt) → {string}

Should insert new link into graph. If the database allows, it is recommended to return a synchronous result. This can be useful in your application. But for writing generic code, it is recommended to only use the callback result.

Source:

graph.js, line 90

Parameters:

Name	Type	Attributes
`link`	`Link`
`callback`	`Graph~insertCallback`	<optional>
`context`	`Object`	<optional>

Returns:

Type:: string

[id]

map(selector, optionsopt, callbackopt) → {Array}

Should map callback over all matching documents. Returns an Array.

Source:

graph.js, line 211

Parameters:

Name	Type	Attributes
`selector`	`string` \| `LinkSelector`
`options`	`SelectOptions`	<optional>
`callback`	`Graph~mapCallback`	<optional>

Returns:

Type:: Array

results

on(event, callback) → {function}

Should subscribe to the events: link, unlink, insert, update, remove.

Source:

graph.js, line 249

Parameters:

Name	Type	Description
`event`	`string`	One event name
`callback`	`Graph~onCallback`

Returns:

Type:: function

Stops event subscription.

Example

var counter = 0;
var stop = graph.on('update', (oldData, newData) => {
  if (oldData.id == '1') console.log(oldData.id, 'is changed');
  counter++;
  if (counter == 3) stop();
});

options(optionsopt) → {*}

Should generate adapter for database options.

Source:

graph.js, line 151

Parameters:

Name	Type	Attributes	Description
`options`	`Object`	<optional>

Returns:

Type:: *

options - a options suitable for the database

query(selector) → {*}

Should generate adapter for database query for links search by unique id or by link query object.

Source:

graph.js, line 143

Parameters:

Name	Type	Description
`selector`	`string` \| `LinkSelector`

Returns:

Type:: *

query

remove(selector, callbackopt, contextopt)

Should remove link by unique id or by link query object.

Source:

graph.js, line 127

Parameters:

Name	Type	Attributes
`selector`	`string` \| `LinkSelector`
`callback`	`Graph~removeCallback`	<optional>
`context`	`Object`	<optional>

update(selector, modifier, callbackopt, contextopt) → {number}

Should update to new state of modifier object link by unique id or by link query object. If the database allows, it is recommended to return a synchronous result. This can be useful in your application. But for writing generic code, it is recommended to only use the callback result.

Source:

graph.js, line 110

Parameters:

Name	Type	Attributes
`selector`	`string` \| `LinkSelector`
`modifier`	`LinkModifier`
`callback`	`Graph~updateCallback`	<optional>
`context`	`Object`	<optional>

Returns:

Type:: number

[count]

Type Definitions

countCallback(erroropt, countopt)

Source:

adapters/object.js, line 441

Parameters:

Name	Type	Attributes	Description
`error`	`Error`	<optional>
`count`	`number`	<optional>

countCallback(erroropt, countopt)

Source:

graph.js, line 229

Parameters:

Name	Type	Attributes	Description
`error`	`Error`	<optional>
`count`	`number`	<optional>

eachCallback(linkopt)

Source:

adapters/object.js, line 403

Parameters:

Name	Type	Attributes	Description
`link`	`Link`	<optional>

eachCallback(linkopt)

Source:

graph.js, line 198

Parameters:

Name	Type	Attributes	Description
`link`	`Link`	<optional>

fetchCallback(erroropt, linksopt)

Optional callback. If present, called with an error object as the first argument and, if no error, the result links objects in array.

Source:

graph.js, line 163

Parameters:

Name	Type	Attributes	Description
`error`	`Error`	<optional>
`links`	`Array.<Link>`	<optional>

fetchCallback(erroropt, linksopt)

Optional callback. If present, called with an error object as the first argument and, if no error, the result links objects in array.

Source:

adapters/object.js, line 381

Parameters:

Name	Type	Attributes	Description
`error`	`Error`	<optional>
`links`	`Array.<Link>`	<optional>

getCallback(erroropt, linkopt)

Optional callback. If present, called with an error object as the first argument and, if no error, the result link object.

Source:

graph.js, line 181

Parameters:

Name	Type	Attributes	Description
`error`	`Error`	<optional>
`link`	`Link`	<optional>

insertCallback(erroropt, idopt)

Optional callback. If present, called with an error object as the first argument and, if no error, the unique id of inserted link as the second.

Source:

graph.js, line 92

Parameters:

Name	Type	Attributes	Description
`error`	`Error`	<optional>
`id`	`string`	<optional>

insertCallback(erroropt, idopt)

Optional callback. If present, called with an error object as the first argument and, if no error, the unique id of inserted link as the second.

Source:

adapters/object.js, line 91

Parameters:

Name	Type	Attributes	Description
`error`	`Error`	<optional>
`id`	`number` \| `string`	<optional>

mapCallback(linkopt) → {*}

Source:

adapters/object.js, line 421

Parameters:

Name	Type	Attributes	Description
`link`	`Link`	<optional>

Returns:

Type:: *

result

mapCallback(linkopt) → {*}

Source:

graph.js, line 213

Parameters:

Name	Type	Attributes	Description
`link`	`Link`	<optional>

Returns:

Type:: *

result

onCallback(oldLinkopt, newLinkopt, contextopt)

Source:

adapters/object.js, line 503

Parameters:

Name	Type	Attributes	Description
`oldLink`	`Link`	<optional>	can be undefined on link and insert events
`newLink`	`Link`	<optional>	can be undefined on unlink and remove events
`context`	`Object`	<optional>	additional app information, such as context.userId

onCallback(oldLinkopt, newLinkopt, contextopt)

Source:

graph.js, line 251

Parameters:

Name	Type	Attributes	Description
`oldLink`	`Link`	<optional>	can be undefined on link and insert events
`newLink`	`Link`	<optional>	can be undefined on unlink and remove events
`context`	`Object`	<optional>	additional app information, such as context.userId

removeCallback(erroropt, countopt)

Optional callback. If present, called with an error object as the first argument.

Source:

graph.js, line 129

Parameters:

Name	Type	Attributes	Description
`error`	`Error`	<optional>
`count`	`number`	<optional>

removeCallback(erroropt, countopt)

Optional callback. If present, called with an error object as the first argument.

Source:

adapters/object.js, line 237

Parameters:

Name	Type	Attributes	Description
`error`	`Error`	<optional>
`count`	`number`	<optional>

updateCallback(erroropt, countopt)

Optional callback. If present, called with an error object as the first argument and, if no error, the number of affected documents as the second.

Source:

adapters/object.js, line 207

Parameters:

Name	Type	Attributes	Description
`error`	`Error`	<optional>
`count`	`number`	<optional>

updateCallback(erroropt, countopt)

Optional callback. If present, called with an error object as the first argument and, if no error, the number of affected documents as the second.

Source:

graph.js, line 112

Parameters:

Name	Type	Attributes	Description
`error`	`Error`	<optional>
`count`	`number`	<optional>