Type generation

When using the .model() method, you receive a generic instance of the Model class. However, due to the fact that each model’s return values and args are dependant on what is in the schema, it is not possible to know ahead of time what each type is. Instead, you can use the generate() function exposed from the @neo4j/graphql package to generate the TypeScript types for your models each time you make a schema change.

The following example shows how to import the generate function from @neo4j/graphql and add a conditional branch to check if the process.env.GENERATE variable has been set like this:

GENERATE="true" ts-node index.ts

Then, once you run this with the variable set, the types become available and you can import and use them as a generic. Here is an example:

import { OGM, generate } from "@neo4j/graphql-ogm";
import { ModelMap } from "./ogm-types"; // this file will be auto-generated using 'generate'
import * as neo4j from "neo4j-driver"
import * as path from "path"

const typeDefs = `
    type Movie {
        id: ID
        name: String

const driver = neo4j.driver(
    neo4j.auth.basic("username", "password")

// Generic is applied on the OGM
const ogm = new OGM<ModelMap>({ typeDefs, driver });

const Movie = ogm.model("Movie");

async function main() {
    // Only generate types when you make a schema change
    if (process.env.GENERATE) {
        const outFile = path.join(__dirname, "ogm-types.ts");

        await generate({

        console.log("Types Generated");


    // Get full autocomplete on `Movie`, including where argument properties plus the return value
    const [theMatrix] = await Movie.find({ where: { name: "The Matrix" } });