GraphRepository
Defined in: types.ts:148
Type Parameters
Section titled “Type Parameters”T extends Record<string, unknown>
Methods
Section titled “Methods”createNode()
Section titled “createNode()”createNode(
data):Promise<T>
Defined in: types.ts:150
Create a node
Parameters
Section titled “Parameters”Partial<T>
Returns
Section titled “Returns”Promise<T>
createRelationship()
Section titled “createRelationship()”createRelationship(
fromId,toId,type,properties?):Promise<void>
Defined in: types.ts:156
Create a directed relationship between two nodes
Parameters
Section titled “Parameters”fromId
Section titled “fromId”string
properties?
Section titled “properties?”Record<string, unknown>
Returns
Section titled “Returns”Promise<void>
deleteNode()
Section titled “deleteNode()”deleteNode(
id):Promise<T>
Defined in: types.ts:160
Delete a node and all its relationships
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<T>
describe()?
Section titled “describe()?”
optionaldescribe():RepositoryCapabilities
Defined in: types.ts:164
Optional capability introspection. All
Returns
Section titled “Returns”Mantlejs
Section titled “Mantlejs”adapters implement it; user repositories may omit it.
findNodeById()
Section titled “findNodeById()”findNodeById(
id):Promise<T|null>
Defined in: types.ts:152
Find a node by ID
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<T | null>
findNodes()
Section titled “findNodes()”findNodes(
params?):Promise<T[]>
Defined in: types.ts:154
Find nodes matching properties
Parameters
Section titled “Parameters”params?
Section titled “params?”Returns
Section titled “Returns”Promise<T[]>
raw<
R>(query,params?):Promise<R[]>
Defined in: types.ts:162
Execute a raw query in the adapter’s native graph language (Cypher for Neo4j, AQL for ArangoDB, …).
Type Parameters
Section titled “Type Parameters”R = T
Parameters
Section titled “Parameters”string
params?
Section titled “params?”Record<string, unknown>
Returns
Section titled “Returns”Promise<R[]>
traverse()
Section titled “traverse()”traverse(
startId,relation,depth?):Promise<T[]>
Defined in: types.ts:158
Traverse relationships from a starting node
Parameters
Section titled “Parameters”startId
Section titled “startId”relation
Section titled “relation”string
depth?
Section titled “depth?”number
Returns
Section titled “Returns”Promise<T[]>