Class EnumField<EntityT, DeSerializersT, EnumT, NullableT, SelectableT>

constructor

• new EnumField<
      EntityT extends EntityBase,
      DeSerializersT extends
          DeSerializers<
              any,
              any,
              any,
              any,
              any,
              any,
              any,
              any,
              any,
              any,
              any,
              any,
              any,
              any,
          >,
      EnumT extends string = string,
      NullableT extends boolean = false,
      SelectableT extends boolean = false,
  >(
      fieldName: string,
      _fieldOf: ConstructorOrField<EntityT>,
      enumType?: Record<string, EnumT>,
      fieldOptions?: FieldOptions<NullableT, SelectableT>,
  ): EnumField<EntityT, DeSerializersT, EnumT, NullableT, SelectableT>

  Creates an instance of EnumField.

  Type Parameters

  • EntityT extends EntityBase
  • DeSerializersT extends DeSerializers<
        any,
        any,
        any,
        any,
        any,
        any,
        any,
        any,
        any,
        any,
        any,
        any,
        any,
        any,
    >
  • EnumT extends string = string
  • NullableT extends boolean = false
  • SelectableT extends boolean = false

  Parameters

  • fieldName: string

    Actual name of the field used in the OData request.
  • _fieldOf: ConstructorOrField<EntityT>

    The constructor of the entity or the complex type field this field belongs to.
  • OptionalenumType: Record<string, EnumT>

    Enum type of the field according to the metadata description.
  • OptionalfieldOptions: FieldOptions<NullableT, SelectableT>

    Optional settings for this field.

  Returns EnumField<EntityT, DeSerializersT, EnumT, NullableT, SelectableT>

Readonly_fieldOf

ReadonlyedmType

Optional ReadonlyenumType

equals

• equals(value: `${EnumT}`): Filter<EntityT, DeSerializersT, string>

  Creates an instance of Filter for this field and the given value using the operator 'eq', i.e. ==.

  Parameters

  • value: `${EnumT}`

    Value to be used in the filter.

  Returns Filter<EntityT, DeSerializersT, string>

  The resulting filter.

fieldPath

• fieldPath(): string

  Gets the path to the complex type property represented by this.

  Returns string

  The path to the complex type property.

notEquals

• notEquals(value: `${EnumT}`): Filter<EntityT, DeSerializersT, string>

  Creates an instance of Filter for this field and the given value using the operator 'ne', i.e. !=.

  Parameters

  • value: `${EnumT}`

    Value to be used in the filter.

  Returns Filter<EntityT, DeSerializersT, string>

  The resulting filter.

  Copyright Ⓒ 2025 SAP SE or an SAP affiliate company. All rights reserved.