Member Junction
    Preparing search index...

    Stores field-level metadata for queries including display names, data types, and formatting rules for result presentation.

    Use MJQueryFieldEntity from @memberjunction/core-entities instead.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    __mj_CreatedAt: Date = null

    Date and time when this field was created

    __mj_UpdatedAt: Date = null

    Date and time when this field was last updated

    AutoDetectConfidenceScore: number = null

    Confidence score (0.00-1.00) when AI detection was used for this field

    ComputationDescription: string = null

    Explanation of how this computed field is calculated

    Description: string = null

    Description of what this field represents

    DetectionMethod: "AI" | "Manual" = 'Manual'

    How this field was detected: AI (automatic) or Manual (user-specified)

    ID: any = null

    Primary Key

    IsComputed: boolean = null

    Whether this field is computed rather than directly selected from a table

    IsSummary: boolean = null

    Whether this field represents a summary/aggregate value

    Name: string = null

    Name of the field as it appears in query results

    QueryID: string = null

    Foreign key to the parent query

    Sequence: number = null

    Display order of this field in query results

    SourceEntity: string = null

    Source entity name if field is from an entity

    SourceEntityID: string = null

    Foreign key to the source entity this field comes from

    SourceFieldName: string = null

    Name of the field in the source entity

    SQLBaseType: string = null

    The base type, not including parameters, in SQL. For example this field would be nvarchar or decimal, and wouldn't include type parameters. The SQLFullType field provides that information.

    SQLFullType: string = null

    The full SQL type for the field, for example datetime or nvarchar(10) etc.

    SummaryDescription: string = null

    Description of the summary calculation

    Accessors

    Methods

    • Copies initialization data from a plain object to the class instance. Only copies properties that already exist on the class to prevent creating new fields. Special handling for DefaultValue fields to extract actual values from SQL Server syntax.

      Parameters

      • initData: any

        The initialization data object

      Returns void

    • Default JSON serialization for BaseInfo subclasses.

      Emits all non-underscored direct field declarations. For _-prefixed private backing fields (the MJ pattern for collection storage — e.g. _Fields, _RelatedEntities, _OrganicKeys), emits the value of the corresponding same-named public getter instead. Purely computed getters without a backing field (display-name formatters, derived flags) are intentionally skipped — they can throw when source fields are null and don't belong on the wire anyway.

      Nested BaseInfo instances and arrays of them unwrap automatically via JSON.stringify's native toJSON() protocol.

      Subclasses may override to emit a filtered subset or custom shape (see EntityFieldValueInfo).

      Returns Record<string, unknown>