Class _Vertex<GraphSchema, NodeName, Node>

Type Parameters

  • GraphSchema extends FullGraph

  • NodeName extends keyof GraphSchema

  • Node extends GraphSchema[NodeName] = GraphSchema[NodeName]

Hierarchy

  • _Vertex

Constructors

constructor

Properties

$id $synced db labels name props

Methods

$delete $pull $push

Constructors

constructor

  • new _Vertex<GraphSchema, NodeName, Node>(db: DB<GraphSchema>, name: NodeName, node: Node<Integer, Properties, string>): _Vertex<GraphSchema, NodeName, Node>

  • Type Parameters

    • GraphSchema extends FullGraph

    • NodeName extends string | number | symbol

    • Node extends NodeShape<string, readonly string[], Record<string, PropValue | RelationShape<boolean, string, readonly string[], Record<string, PropValue>>>, {}, {}, Node> = GraphSchema[NodeName]

    Parameters

    • db: DB<GraphSchema>
    • name: NodeName
    • node: Node<Integer, Properties, string>

    Returns _Vertex<GraphSchema, NodeName, Node>

Properties

Readonly $id

$id: string

The unique identifier of this vertex (node)

$synced

$synced: boolean

The sync state of the vertex, true if all local changes are synced with the database

Protected db

db: DB<GraphSchema>

labels

labels: Node["labels"]

The labels of this vertex (node)

name

name: NodeName

props

props: { [ K in string | number | symbol]: Node["props"][K] extends ZodType<any, ZodTypeDef, any> ? TypeOf<any[any]> : never }

The properties of this vertex (node)

Methods

$delete

  • $delete(): Promise<void>

  • Delete the vertex (and its relations) from the database

    Returns Promise<void>

$pull

$push

Settings

Member Visibility

Theme

Generated using TypeDoc