Class CollectionField<EntityT, DeSerializersT, CollectionFieldT, NullableT, SelectableT>

Represents a field of an entity or a complex type, that can have a collection as value.

Type Parameters

EntityT extends EntityBase

Type of the entity the field belongs to.
DeSerializersT extends DeSerializers

Type of the (de-)serializers.
CollectionFieldT extends EdmTypeShared<"any"> | Record<string, any> = any

Type of of elements of the collection. This can either be an EDM type or complex type.
NullableT extends boolean = false

Boolean type that represents whether the field is nullable.
SelectableT extends boolean = false

Boolean type that represents whether the field is selectable.

Hierarchy

Field<EntityT, NullableT, SelectableT>
- CollectionField

Index

Constructors

Properties

_deSerializers _entityConstructor _fieldName _fieldOf _fieldOptions _fieldType

Methods

Constructors

constructor

new CollectionField<EntityT, DeSerializersT, CollectionFieldT, NullableT, SelectableT>(fieldName: string, _fieldOf: ConstructorOrField<EntityT, any>, _fieldType: CollectionFieldType<CollectionFieldT>, fieldOptions?: FieldOptions<NullableT, SelectableT>): CollectionField<EntityT, DeSerializersT, CollectionFieldT, NullableT, SelectableT>
Creates an instance of CollectionField.
Type Parameters
- EntityT extends EntityBase<EntityT>
- DeSerializersT extends DeSerializers<any, any, any, any, any, any, any, any, any, any, any, any, any, any, DeSerializersT>
- CollectionFieldT extends Record<string, any> | EdmTypeCommon | ExclusiveEdmTypeV2 | ExclusiveEdmTypeV4 = any
- NullableT extends boolean = false
- SelectableT extends boolean = false
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: CollectionFieldType<CollectionFieldT>
  
  Edm type of the field according to the metadata description.
- Optional fieldOptions: FieldOptions<NullableT, SelectableT>
  
  Optional settings for this field.
Returns CollectionField<EntityT, DeSerializersT, CollectionFieldT, NullableT, SelectableT>
Overrides Field.constructor
- Defined in packages/odata-common/dist/selectable/collection-field.d.ts:26

Properties

`Readonly` _deSerializers

_deSerializers: DeSerializersT

`Readonly` _entityConstructor

_entityConstructor: Constructable<EntityT>

`Readonly` _fieldName

_fieldName: string

`Readonly` _fieldOf

_fieldOf: ConstructorOrField<EntityT, any>

`Readonly` _fieldOptions

_fieldOptions: Required<FieldOptions<NullableT, SelectableT>>

`Readonly` _fieldType

_fieldType: CollectionFieldType<CollectionFieldT>

Methods

fieldPath

fieldPath(): string
Gets the path to the complex type property represented by this.

Returns
The path to the complex type property.

Returns string
Overrides Field.fieldPath
- Defined in packages/odata-common/dist/selectable/collection-field.d.ts:31

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