Class CustomField<EntityT, DeSerializersT, NullableT>

If your entity contains fields not present in your service specification you can model them using custom fields. Alternatively you can also generate a client based on a service specification containing all fields.

Type Parameters

Hierarchy

  • CustomField<EntityT, DeSerializersT, NullableT>
    • CustomField

Constructors

  • Type Parameters

    • EntityT extends Entity<EntityT>

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

    • NullableT extends boolean = false

    Parameters

    • fieldName: string
    • entityConstructor: Constructable<EntityT>
    • deSerializers: DeSerializersT
    • Optional isNullable: NullableT

    Returns CustomField<EntityT, DeSerializersT, NullableT>

Properties

_entityConstructor: Constructable<EntityT>
_fieldName: string
_fieldOptions: Required<FieldOptions<NullableT, false>>
fieldBuilder: FieldBuilder<Constructable<EntityT>, DeSerializersT>

Methods

  • Returns EdmTypeField<EntityT, DeSerializersT, "Edm.Binary", NullableT, true>

  • Returns EdmTypeField<EntityT, DeSerializersT, "Edm.Boolean", NullableT, true>

  • Returns OrderableEdmTypeField<EntityT, DeSerializersT, "Edm.DateTime", NullableT, true>

  • Returns EdmTypeField<EntityT, DeSerializersT, "Edm.Guid", NullableT, true>

  • Returns EdmTypeField<EntityT, DeSerializersT, "Edm.String", NullableT, true>

  • Returns OrderableEdmTypeField<EntityT, DeSerializersT, "Edm.Time", NullableT, true>

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

    Returns

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

    Returns string

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