Prometheus Entity Management API
    Preparing search index...

    Interface PrismaEntityConfigOptions<TEntity>

    Options for createPrismaEntityConfig: one REST-backed resource aligned with Prisma-style where / orderBy / include payloads.

    interface PrismaEntityConfigOptions<TEntity extends object> {
        endpoint: string;
        idField?: string;
        relations?: Record<
            string,
            {
                foreignKey: string;
                relation: "belongsTo"
                | "hasMany"
                | "manyToMany";
                type: string;
            },
        >;
        type: string;
    }

    Type Parameters

    • TEntity extends object
    Index
    endpoint idField? relations? type
    endpoint: string

    Base REST URL for the collection (list) and detail as ${endpoint}/:id.

    idField?: string

    Primary key field on normalized entities (default "id").

    relations?: Record<
        string,
        {
            foreignKey: string;
            relation: "belongsTo"
            | "hasMany"
            | "manyToMany";
            type: string;
        },
    >

    Declarative relations (Prisma-flavored names) used to build EntitySchema and toPrismaInclude. type is the related model; foreignKey is the FK or scalar list field name as in your API.

    type: string

    Graph entity type key (e.g. "Task").

    Settings
    Member Visibility

    On This Page
    Properties