Options
All
  • Public
  • Public/Protected
  • All
Menu

Represents a static field of an entity or complex type.

Type parameters

  • EntityT: EntityBase

    Type of the entity the field belongs to

  • FieldT: EdmTypeShared<"any"> | Record<string, any> = any

    Type of the entries of the collection in the field

Hierarchy

  • Field<EntityT>
    • CollectionField

Implements

Index

Constructors

constructor

  • Creates an instance of CollectionField.

    Type parameters

    • EntityT: EntityBase<EntityT>

    • FieldT: Record<string, any> | "Edm.String" | "Edm.Boolean" | "Edm.Decimal" | "Edm.Double" | "Edm.Single" | "Edm.Float" | "Edm.Int16" | "Edm.Int32" | "Edm.Int64" | "Edm.SByte" | "Edm.Binary" | "Edm.Guid" | "Edm.Byte" | "Edm.Any" | "Edm.DateTimeOffset" | "Edm.DateTime" | "Edm.Time" | "Edm.Date" | "Edm.Duration" | "Edm.TimeOfDay" | "Edm.Enum" = any

    Parameters

    • fieldName: string

      Actual name of the field used in the OData request.

    • fieldOf: ConstructorOrField<EntityT, any>

      The constructor of the entity or the complex type field this field belongs to.

    • _fieldType: FieldT | ComplexTypeNamespace<FieldT>

      Type of the field according to the metadata description.

    Returns CollectionField<EntityT, FieldT>

Properties

Readonly _entity

_entity: EntityT

Readonly _entityConstructor

_entityConstructor: Constructable<EntityT, unknown>

Readonly _fieldName

_fieldName: string

Readonly _fieldType

_fieldType: FieldT | ComplexTypeNamespace<FieldT>

Readonly selectable

selectable: true

This property denotes that this is a selectable edm type field.

Methods

fieldPath

  • fieldPath(): string
  • Path to the field to be used in filter and order by queries. In most cases this will just be the _fieldName itself. However, for complex types for instance, the path is prefixed with the name of the complextype.

    Returns string

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