Entity

    Class EntityFieldDefinition<T, TRequireExplicitCache>Abstract

    Definition for a field referencing a column in the underlying database. Specifies things like cache behavior and associations, and handles input validation.

    Type Parameters

    • T
    • TRequireExplicitCache extends boolean

    Hierarchy (View Summary, Expand)

    Index

    Constructors

    constructor

    Properties

    _cacheRawSentinel association cache columnName

    Methods

    validateInputValue validateInputValueInternal

    Constructors

    Properties

    Protected Readonly_cacheRawSentinel

    _cacheRawSentinel: TRequireExplicitCache
    association:
        | undefined
        | EntityAssociationDefinition<any, any, any, any, any, any>
    cache: boolean
    columnName: string

    Methods

    • Validates input value for a field of this type. Null and undefined are considered valid by default. This is used for things like:

      • EntityLoader.loadByFieldValue - to ensure the value being loaded by is a valid value
      • EntityMutator.setField - to ensure the value being set is a valid value

      Parameters

      • value: undefined | null | T

      Returns boolean

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    MMNEPVFCICPMFPCPTTAAATR