- Preparing search index...
- The search index is not available
typed-neo4j
Class DB<VertexSchema, EdgeSchema>
Type Parameters
-
VertexSchema extends Omit<Record<string, Record<string, unknown>>, string> = Record<string, Record<string, unknown>>
-
EdgeSchema extends Omit<Record<string, EdgeSchema>, string> = Record<string, EdgeSchema>
Constructors
constructor
- new DB<VertexSchema, EdgeSchema>(database?: string): DB<VertexSchema, EdgeSchema>
-
Type Parameters
-
VertexSchema extends Omit<Record<string, Record<string, unknown>>, string> = Record<string, Record<string, unknown>>
-
EdgeSchema extends Omit<Record<string, EdgeSchema<Omit<Vertex, "$id">, Omit<Vertex, "$id">, Record<string, unknown>>>, string> = Record<string, EdgeSchema<Omit<Vertex, "$id">, Omit<Vertex, "$id">, Record<string, unknown>>>
Parameters
-
database: string = "neo4j"
Returns DB<VertexSchema, EdgeSchema>
Properties
Private Readonly session
session: Session
Methods
close
- close(): Promise<void>
-
Returns Promise<void>
create
- create<T, V>(label: V, props: V extends keyof VertexSchema ? VertexSchema[V] | VertexSchema[V][] : T | T[]): Promise<(Vertex & (V extends keyof VertexSchema ? VertexSchema[V] : T))[]>
-
Type Parameters
-
T extends Record<string, unknown>
-
V extends string | number | symbol
Parameters
-
label: V
-
props: V extends keyof VertexSchema ? VertexSchema[V] | VertexSchema[V][] : T | T[]
Returns Promise<(Vertex & (V extends keyof VertexSchema ? VertexSchema[V] : T))[]>
find
- find<T, V>(label: V, props?: V extends keyof VertexSchema ? Partial<VertexSchema[V]> : T, config?: {
limit?: number;
order?: { [ key in string | number | symbol]?: "asc" | "desc" };
skip?: number;
}): Promise<(Vertex & (V extends keyof VertexSchema ? VertexSchema[V] : T))[]>
-
Type Parameters
-
T extends Record<string, unknown>
-
V extends string | number | symbol
Parameters
-
label: V
-
props: V extends keyof VertexSchema ? Partial<VertexSchema[V]> : T = ...
-
config: {
limit?: number;
order?: { [ key in string | number | symbol]?: "asc" | "desc" };
skip?: number;
} = {}
-
Optional limit?: number
-
Optional order?: { [ key in string | number | symbol]?: "asc" | "desc" }
-
Optional skip?: number
Returns Promise<(Vertex & (V extends keyof VertexSchema ? VertexSchema[V] : T))[]>
link
- link<T, E, VF, VT>(source: VF | VF[], rel: E, targets: VT | VT[], props?: E extends keyof EdgeSchema ? EdgeProps<EdgeSchema[E]> : T): Promise<void>
-
Type Parameters
-
T extends Record<string, unknown>
-
E extends string | number | symbol
-
VF extends Omit<Vertex, "$id"> & Vertex
-
VT extends Omit<Vertex, "$id"> & Vertex
Parameters
-
source: VF | VF[]
-
rel: E
-
targets: VT | VT[]
-
props: E extends keyof EdgeSchema ? EdgeProps<EdgeSchema[E]> : T = ...
Returns Promise<void>
reset
- reset(): Promise<void>
-
Returns Promise<void>
run
- run(query: string, params?: Record<string, unknown>): Promise<Result<Dict<PropertyKey, any>>>
-
Parameters
-
query: string
-
Optional params: Record<string, unknown>
Returns Promise<Result<Dict<PropertyKey, any>>>