Class GraphRuntime

Constructors

constructor

new GraphRuntime(graphId?: string): GraphRuntime
Parameters
- OptionalgraphId: string
Returns GraphRuntime
- Defined in graph/dist/runtime.d.ts:26

Accessors

graphId

get graphId(): string
Returns string
- Defined in graph/dist/runtime.d.ts:28

status

get status(): GraphLifecycleState
Returns GraphLifecycleState
- Defined in graph/dist/runtime.d.ts:27

Methods

activate

activate(): void
Returns void
- Defined in graph/dist/runtime.d.ts:31

activateParticipant

activateParticipant(participantId: string): Participant
Parameters
- participantId: string
Returns Participant
- Defined in graph/dist/runtime.d.ts:38

addEdge

addEdge(participantId: string, params: AddEdgeParams): Edge
Parameters
- participantId: string
- params: AddEdgeParams
Returns Edge
- Defined in graph/dist/runtime.d.ts:50

addEdgeLabel

addEdgeLabel(participantId: string, edgeId: string, label: string): Edge
Parameters
- participantId: string
- edgeId: string
- label: string
Returns Edge
- Defined in graph/dist/runtime.d.ts:55

addNode

addNode(participantId: string, params: AddNodeParams): Node
Parameters
- participantId: string
- params: AddNodeParams
Returns Node
- Defined in graph/dist/runtime.d.ts:49

addNodeLabel

addNodeLabel(participantId: string, nodeId: string, label: string): Node
Parameters
- participantId: string
- nodeId: string
- label: string
Returns Node
- Defined in graph/dist/runtime.d.ts:53

beginTransaction

beginTransaction(participantId: string): Transaction
Parameters
- participantId: string
Returns Transaction
- Defined in graph/dist/runtime.d.ts:42

commit

commit(participantId: string): void
Parameters
- participantId: string
Returns void
- Defined in graph/dist/runtime.d.ts:43

deregister

deregister(participantId: string): void
Parameters
- participantId: string
Returns void
- Defined in graph/dist/runtime.d.ts:39

getActiveTransaction

getActiveTransaction(): Transaction | null
Returns Transaction | null
- Defined in graph/dist/runtime.d.ts:48

getEdge

getEdge(id: string): Edge | undefined
Parameters
- id: string
Returns Edge | undefined
- Defined in graph/dist/runtime.d.ts:67

getEdges

getEdges(): Edge[]
Returns Edge[]
- Defined in graph/dist/runtime.d.ts:71

getEdgesForNode

getEdgesForNode(nodeId: string, direction?: Direction): Edge[]
Parameters
- nodeId: string
- Optionaldirection: Direction
Returns Edge[]
- Defined in graph/dist/runtime.d.ts:72

getNeighbors

getNeighbors(nodeId: string, direction?: Direction): Node[]
Parameters
- nodeId: string
- Optionaldirection: Direction
Returns Node[]
- Defined in graph/dist/runtime.d.ts:73

getNode

getNode(id: string): Node | undefined
Parameters
- id: string
Returns Node | undefined
- Defined in graph/dist/runtime.d.ts:65

getNodeByObjectId

getNodeByObjectId(objectId: string): Node | undefined
Parameters
- objectId: string
Returns Node | undefined
- Defined in graph/dist/runtime.d.ts:66

getNodes

getNodes(): Node[]
Returns Node[]
- Defined in graph/dist/runtime.d.ts:70

getParticipant

getParticipant(id: string): Participant | undefined
Parameters
- id: string
Returns Participant | undefined
- Defined in graph/dist/runtime.d.ts:40

getState

getState(): RuntimeState
Returns RuntimeState
- Defined in graph/dist/runtime.d.ts:29

hasEdge

hasEdge(id: string): boolean
Parameters
- id: string
Returns boolean
- Defined in graph/dist/runtime.d.ts:69

hasNode

hasNode(id: string): boolean
Parameters
- id: string
Returns boolean
- Defined in graph/dist/runtime.d.ts:68

init

init(): void
Returns void
- Defined in graph/dist/runtime.d.ts:30

register

register(participantId: string, metadata?: Record<string, unknown>): Participant
Parameters
- participantId: string
- Optionalmetadata: Record<string, unknown>
Returns Participant
- Defined in graph/dist/runtime.d.ts:37

removeEdge

removeEdge(participantId: string, edgeId: string): Edge
Parameters
- participantId: string
- edgeId: string
Returns Edge
- Defined in graph/dist/runtime.d.ts:61

removeEdgeLabel

removeEdgeLabel(participantId: string, edgeId: string, label: string): Edge
Parameters
- participantId: string
- edgeId: string
- label: string
Returns Edge
- Defined in graph/dist/runtime.d.ts:56

removeNode

removeNode(
participantId: string,
nodeId: string,
): { cascadeEdges: string[]; node: Node }
Parameters
- participantId: string
- nodeId: string
Returns { cascadeEdges: string[]; node: Node }
- Defined in graph/dist/runtime.d.ts:57

removeNodeLabel

removeNodeLabel(participantId: string, nodeId: string, label: string): Node
Parameters
- participantId: string
- nodeId: string
- label: string
Returns Node
- Defined in graph/dist/runtime.d.ts:54

rollback

rollback(participantId: string): void
Parameters
- participantId: string
Returns void
- Defined in graph/dist/runtime.d.ts:44

shutdown

shutdown(): void
Returns void
- Defined in graph/dist/runtime.d.ts:33

subscribe(type: string, handler: (event: GraphEvent) => void): () => void
Parameters
- type: string
- handler: (event: GraphEvent) => void
Returns () => void
- Defined in graph/dist/runtime.d.ts:74

subscribeAll

subscribeAll(handler: (event: GraphEvent) => void): () => void
Parameters
- handler: (event: GraphEvent) => void
Returns () => void
- Defined in graph/dist/runtime.d.ts:75

suspend

suspend(): void
Returns void
- Defined in graph/dist/runtime.d.ts:32

updateEdgeProperties

updateEdgeProperties(
    participantId: string,
    edgeId: string,
    params: UpdatePropertiesParams,
): Edge
Parameters
- participantId: string
- edgeId: string
- params: UpdatePropertiesParams
Returns Edge
- Defined in graph/dist/runtime.d.ts:52

updateNodeProperties

updateNodeProperties(
    participantId: string,
    nodeId: string,
    params: UpdatePropertiesParams,
): Node
Parameters
- participantId: string
- nodeId: string
- params: UpdatePropertiesParams
Returns Node
- Defined in graph/dist/runtime.d.ts:51