Options
All
  • Public
  • Public/Protected
  • All
Menu

Represents a selectable property with a enum value.

Type parameters

  • EntityT: EntityBase

    Type of the entity the field belongs to

Hierarchy

  • EnumFieldBase<EntityT, true>
    • EnumField

Index

Constructors

constructor

  • new EnumField<EntityT>(fieldName: string, fieldOf: Constructable<EntityT, unknown>): EnumField<EntityT>
  • Type parameters

    Parameters

    • fieldName: string
    • fieldOf: Constructable<EntityT, unknown>

    Returns EnumField<EntityT>

Properties

Readonly _entity

_entity: EntityT

Readonly _entityConstructor

_entityConstructor: Constructable<EntityT, unknown>

Readonly _fieldName

_fieldName: string

Readonly _fieldOf

_fieldOf: ConstructorOrField<EntityT, any>

Readonly _fieldOptions

_fieldOptions: Required<FieldOptions<false, true>>

Readonly edmType

Methods

equals

  • equals(value: string): Filter<EntityT, string>
  • Creates an instance of Filter for this field and the given value using the operator 'eq', i.e. ==.

    Parameters

    • value: string

      Value to be used in the filter

    Returns Filter<EntityT, string>

    The resulting filter

fieldPath

  • fieldPath(): string
  • Path to the field to be used in filter and order by queries.

    Returns string

    Path to the field to be used in filter and order by queries.

notEquals

  • notEquals(value: string): Filter<EntityT, string>
  • Creates an instance of Filter for this field and the given value using the operator 'ne', i.e. !=.

    Parameters

    • value: string

      Value to be used in the filter

    Returns Filter<EntityT, string>

    The resulting filter