Class EnumField<TRequireExplicitCache>

EntityFieldDefinition for a enum column with a JS string or number type.

Type Parameters

TRequireExplicitCache extends boolean

Hierarchy (View Summary, Expand)

EntityFieldDefinition<string | number, TRequireExplicitCache>
- EnumField
  - StrictEnumField

Index

Constructors

Properties

_cacheRawSentinel association cache columnName

Methods

validateInputValue validateInputValueInternal

Constructors

constructor

new EnumField<TRequireExplicitCache extends boolean>(
    options: TRequireExplicitCache extends true
        ? EntityFieldDefinitionOptionsExplicitCache
        : EntityFieldDefinitionOptions,
): EnumField<TRequireExplicitCache>
Type Parameters
- TRequireExplicitCache extends boolean
Parameters
- options: TRequireExplicitCache extends true
  ? EntityFieldDefinitionOptionsExplicitCache
  : EntityFieldDefinitionOptions
  options for this field definition
Returns EnumField<TRequireExplicitCache>
Inherited from EntityFieldDefinition.constructor
- Defined in packages/entity/src/EntityFieldDefinition.ts:185

Properties

`Protected` `Readonly`_cacheRawSentinel

_cacheRawSentinel: TRequireExplicitCache

`Readonly`association

association:
| undefined
| EntityAssociationDefinition<any, any, any, any, any, any>

`Readonly`cache

cache: boolean

`Readonly`columnName

columnName: string

Methods

validateInputValue

validateInputValue(value: undefined | null | string | number): boolean
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 | string | number
Returns boolean
Inherited from EntityFieldDefinition.validateInputValue
- Defined in packages/entity/src/EntityFieldDefinition.ts:200

`Protected`validateInputValueInternal

validateInputValueInternal(value: string | number): boolean
Parameters
- value: string | number
Returns boolean
Overrides EntityFieldDefinition.validateInputValueInternal
- Defined in packages/entity/src/EntityFields.ts:117