Class FieldBuilder<FieldOfT, DeSerializersT>

Field builder to orchestrate the creation of the different kinds of fields.

Type Parameters

FieldOfT extends ConstructorOrField<any>

Type of the entity or complex type field this field belongs to.
DeSerializersT extends DeSerializers

Type of the (de-)serializers.

Hierarchy

FieldBuilder

Index

Constructors

constructor

new FieldBuilder<FieldOfT, DeSerializersT>(fieldOf: FieldOfT, deSerializers: DeSerializersT): FieldBuilder<FieldOfT, DeSerializersT>
Creates an instance of FieldBuilder.
Type Parameters
- FieldOfT extends ConstructorOrField<any, any>
- DeSerializersT extends DeSerializers<any, any, any, any, any, any, any, any, any, any, any, any, any, any, DeSerializersT>
Parameters
- fieldOf: FieldOfT
  
  Entity or complex type field, for which the field builder shall create fields.
- deSerializers: DeSerializersT
  
  (De-)serializers used for transformation.
Returns FieldBuilder<FieldOfT, DeSerializersT>
- Defined in packages/odata-common/dist/selectable/field-builder.d.ts:43

Properties

fieldOf

fieldOf: FieldOfT

Methods

buildCollectionField

buildCollectionField<CollectionFieldT, NullableT>(fieldName: string, collectionFieldType: CollectionFieldType<CollectionFieldT>, isNullable: NullableT): CollectionField<EntityTypeFromFieldOf<FieldOfT>, DeSerializersT, CollectionFieldT, NullableT, IsSelectableField<FieldOfT>>
Build a field for a property with a collection type. The type of the field can either be an EDM type or a complex type. Fields of entities are selectable; fields of complex types are not selectable.

Returns
A collection field with the given collection type.
Type Parameters
- CollectionFieldT extends Record<string, any> | EdmTypeCommon | ExclusiveEdmTypeV2 | ExclusiveEdmTypeV4
- NullableT extends boolean
Parameters
- fieldName: string
  
  Name of the field.
- collectionFieldType: CollectionFieldType<CollectionFieldT>
  
  Type of the collection. Can either be an EDM type or complex type (not complex type field).
- isNullable: NullableT
  
  Whether the field is nullable.
Returns CollectionField<EntityTypeFromFieldOf<FieldOfT>, DeSerializersT, CollectionFieldT, NullableT, IsSelectableField<FieldOfT>>
- Defined in packages/odata-common/dist/selectable/field-builder.d.ts:64

buildComplexTypeField

buildComplexTypeField<ComplexTypeFieldT, ComplexT, NullableT>(fieldName: string, complexTypeFieldCtor: ComplexTypeFieldConstructor<ComplexTypeFieldT, EntityTypeFromFieldOf<FieldOfT>, DeSerializersT, ComplexT, NullableT, IsSelectableField<FieldOfT>>, isNullable: NullableT): ComplexTypeFieldT
Build a field for a property with a complex type. Fields of entities are selectable; fields of complex types are not selectable.

Returns
A complex type field of the given type.
Type Parameters
- ComplexTypeFieldT extends ComplexTypeField<EntityTypeFromFieldOf<FieldOfT>, DeSerializersT, any, NullableT, IsSelectableField<FieldOfT>, ComplexTypeFieldT>
- ComplexT
- NullableT extends boolean
Parameters
- fieldName: string
  
  Name of the field.
- complexTypeFieldCtor: ComplexTypeFieldConstructor<ComplexTypeFieldT, EntityTypeFromFieldOf<FieldOfT>, DeSerializersT, ComplexT, NullableT, IsSelectableField<FieldOfT>>
  
  Constructor of the complex type field.
- isNullable: NullableT
  
  Whether the field is nullable.
Returns ComplexTypeFieldT
- Defined in packages/odata-common/dist/selectable/field-builder.d.ts:54

buildEdmTypeField

buildEdmTypeField<EdmT, NullableT>(fieldName: string, edmType: EdmT, isNullable: NullableT): OrderableEdmTypeField<EntityTypeFromFieldOf<FieldOfT>, DeSerializersT, EdmT, NullableT, IsSelectableField<FieldOfT>>
Type Parameters
- EdmT extends OrderableEdmType
- NullableT extends boolean
Parameters
- fieldName: string
- edmType: EdmT
- isNullable: NullableT
Returns OrderableEdmTypeField<EntityTypeFromFieldOf<FieldOfT>, DeSerializersT, EdmT, NullableT, IsSelectableField<FieldOfT>>
- Defined in packages/odata-common/dist/selectable/field-builder.d.ts:44
buildEdmTypeField<EdmT, NullableT>(fieldName: string, edmType: EdmT, isNullable: NullableT): EdmTypeField<EntityTypeFromFieldOf<FieldOfT>, DeSerializersT, EdmT, NullableT, IsSelectableField<FieldOfT>>
Type Parameters
- EdmT extends "Edm.Binary" | "Edm.Any" | "Edm.Enum"
- NullableT extends boolean
Parameters
- fieldName: string
- edmType: EdmT
- isNullable: NullableT
Returns EdmTypeField<EntityTypeFromFieldOf<FieldOfT>, DeSerializersT, EdmT, NullableT, IsSelectableField<FieldOfT>>
- Defined in packages/odata-common/dist/selectable/field-builder.d.ts:45

buildEnumField

buildEnumField<EnumT, NullableT>(fieldName: string, enumType: Record<string, EnumT>, isNullable: NullableT): EnumField<EntityTypeFromFieldOf<FieldOfT>, DeSerializersT, EnumT, NullableT, IsSelectableField<FieldOfT>>
Build a field for a property with a enum type.

Returns
A collection field with the given collection type.
Type Parameters
- EnumT extends string
- NullableT extends boolean
Parameters
- fieldName: string
  
  Name of the field.
- enumType: Record<string, EnumT>
  
  Enum type of this field.
- isNullable: NullableT
  
  Whether the field is nullable.
Returns EnumField<EntityTypeFromFieldOf<FieldOfT>, DeSerializersT, EnumT, NullableT, IsSelectableField<FieldOfT>>
- Defined in packages/odata-common/dist/selectable/field-builder.d.ts:72

Class FieldBuilder<FieldOfT, DeSerializersT>

Type Parameters

FieldOfT extends ConstructorOrField<any>

DeSerializersT extends DeSerializers

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

FieldOfT extends ConstructorOrField<any, any>

DeSerializersT extends DeSerializers<any, any, any, any, any, any, any, any, any, any, any, any, any, any, DeSerializersT>

Parameters

fieldOf: FieldOfT

deSerializers: DeSerializersT

Returns FieldBuilder<FieldOfT, DeSerializersT>

Properties

fieldOf

Methods

buildCollectionField

Returns

Type Parameters

CollectionFieldT extends Record<string, any> | EdmTypeCommon | ExclusiveEdmTypeV2 | ExclusiveEdmTypeV4

NullableT extends boolean

Parameters

fieldName: string

collectionFieldType: CollectionFieldType<CollectionFieldT>

isNullable: NullableT

Returns CollectionField<EntityTypeFromFieldOf<FieldOfT>, DeSerializersT, CollectionFieldT, NullableT, IsSelectableField<FieldOfT>>

buildComplexTypeField

Returns

Type Parameters

ComplexTypeFieldT extends ComplexTypeField<EntityTypeFromFieldOf<FieldOfT>, DeSerializersT, any, NullableT, IsSelectableField<FieldOfT>, ComplexTypeFieldT>

ComplexT

NullableT extends boolean

Parameters

fieldName: string

complexTypeFieldCtor: ComplexTypeFieldConstructor<ComplexTypeFieldT, EntityTypeFromFieldOf<FieldOfT>, DeSerializersT, ComplexT, NullableT, IsSelectableField<FieldOfT>>

isNullable: NullableT

Returns ComplexTypeFieldT

buildEdmTypeField

Type Parameters

EdmT extends OrderableEdmType

NullableT extends boolean

Parameters

fieldName: string

edmType: EdmT

isNullable: NullableT

Returns OrderableEdmTypeField<EntityTypeFromFieldOf<FieldOfT>, DeSerializersT, EdmT, NullableT, IsSelectableField<FieldOfT>>

Type Parameters

EdmT extends "Edm.Binary" | "Edm.Any" | "Edm.Enum"

NullableT extends boolean

Parameters

fieldName: string

edmType: EdmT

isNullable: NullableT

Returns EdmTypeField<EntityTypeFromFieldOf<FieldOfT>, DeSerializersT, EdmT, NullableT, IsSelectableField<FieldOfT>>

buildEnumField

Returns

Type Parameters

EnumT extends string

NullableT extends boolean

Parameters

fieldName: string

enumType: Record<string, EnumT>

isNullable: NullableT

Returns EnumField<EntityTypeFromFieldOf<FieldOfT>, DeSerializersT, EnumT, NullableT, IsSelectableField<FieldOfT>>

Settings

Member Visibility

Theme