Entity
    Preparing search index...

    Class StrictEnumField<T, TRequireExplicitCache>

    EntityFieldDefinition for a enum column with a strict typescript enum type. The strict version checks that the value of the field adheres to a particular typescript enum

    Type Parameters

    • T extends object
    • TRequireExplicitCache extends boolean

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    _cacheRawSentinel association cache columnName

    Methods

    validateInputValue validateInputValueInternal

    Constructors

    Properties

    Protected Readonly_cacheRawSentinel

    _cacheRawSentinel: TRequireExplicitCache
    association:
        | EntityAssociationDefinition<any, any, any, any, any, any>
        | undefined
    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: string | number | null | undefined

      Returns boolean

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods