Options
All
  • Public
  • Public/Protected
  • All
Menu

Class OrderableEdmTypeField<EntityT, EdmT, NullableT, SelectableT>

EdmTypeField, that represents a property with an EDM type, that can be compared with greaterThan, greaterOrEqual, lessThan and lessOrEqual.

Type parameters

  • EntityT: EntityBase

    Type of the entity the field belongs to

  • EdmT: EdmTypeShared<"any">

    EDM type of the field.

  • NullableT: boolean = false

    Boolean type that represents whether the field is nullable.

  • SelectableT: boolean = false

    Boolean type that represents whether the field is selectable.

Hierarchy

  • EdmTypeField<EntityT, EdmT, NullableT, SelectableT>
    • OrderableEdmTypeField

Index

Constructors

constructor

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<NullableT, SelectableT>>

Readonly edmType

Methods

equals

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.

greaterOrEqual

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

    Parameters

    Returns Filter<EntityT, NullableFieldType<EdmT extends EdmTypeCommon | ExclusiveEdmTypeV2 | ExclusiveEdmTypeV4 ? NonNullableFieldTypeByEdmType<EdmT> : EdmT, NullableT>>

    The resulting filter

greaterThan

  • Creates an instance of Filter for this field and the given value using the operator 'gt', i.e. >.

    Parameters

    Returns Filter<EntityT, NullableFieldType<EdmT extends EdmTypeCommon | ExclusiveEdmTypeV2 | ExclusiveEdmTypeV4 ? NonNullableFieldTypeByEdmType<EdmT> : EdmT, NullableT>>

    The resulting filter

lessOrEqual

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

    Parameters

    Returns Filter<EntityT, NullableFieldType<EdmT extends EdmTypeCommon | ExclusiveEdmTypeV2 | ExclusiveEdmTypeV4 ? NonNullableFieldTypeByEdmType<EdmT> : EdmT, NullableT>>

    The resulting filter

lessThan

  • Creates an instance of Filter for this field and the given value using the operator 'lt', i.e. <.

    Parameters

    Returns Filter<EntityT, NullableFieldType<EdmT extends EdmTypeCommon | ExclusiveEdmTypeV2 | ExclusiveEdmTypeV4 ? NonNullableFieldTypeByEdmType<EdmT> : EdmT, NullableT>>

    The resulting filter

notEquals