AutoBE
    Preparing search index...

    Interface IPlainField

    A regular data field (not a primary or foreign key).

    interface IPlainField {
        description: string;
        name: string & SnakeCasePattern;
        nullable: boolean;
        type:
            | "string"
            | "boolean"
            | "uuid"
            | "email"
            | "ipv4"
            | "uri"
            | "int"
            | "double"
            | "datetime";
    }
    Index

    Properties

    description name nullable type

    Properties

    description: string

    Business purpose of this field.

    Format: summary sentence first, \n\n, then paragraphs grouped by topic. Use {@\link ModelName} for cross-references.

    MUST be written in English.

    name: string & SnakeCasePattern

    MUST use snake_case.

    nullable: boolean

    Whether this field can be null.

    type:
        | "string"
        | "boolean"
        | "uuid"
        | "email"
        | "ipv4"
        | "uri"
        | "int"
        | "double"
        | "datetime"

    Prisma/PostgreSQL type mapping: boolean, int, double, string, uri, uuid (non-FK), datetime, email, ipv4.

    Settings

    Member Visibility

    On This Page

    Properties