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

EntityT extends Entity
DeSerializersT extends DeSerializers
NullableT extends boolean = false

Hierarchy (View Summary)

CustomField<EntityT, DeSerializersT, NullableT>
- CustomField

Index

Constructors

constructor

new CustomField<
    EntityT extends Entity,
    DeSerializersT extends
        DeSerializers<
            any,
            any,
            any,
            any,
            any,
            any,
            any,
            any,
            any,
            any,
            any,
            any,
            any,
            any,
            any,
            any,
            any,
        >,
    NullableT extends boolean = false,
>(
    fieldName: string,
    entityConstructor: Constructable<EntityT>,
    deSerializers: DeSerializersT,
    isNullable?: NullableT,
): CustomField<EntityT, DeSerializersT, NullableT>
Type Parameters
- EntityT extends Entity
- DeSerializersT extends DeSerializers<
      any,
      any,
      any,
      any,
      any,
      any,
      any,
      any,
      any,
      any,
      any,
      any,
      any,
      any,
      any,
      any,
      any,
  >
- NullableT extends boolean = false
Parameters
- fieldName: string
- entityConstructor: Constructable<EntityT>
- deSerializers: DeSerializersT
- OptionalisNullable: NullableT
Returns CustomField<EntityT, DeSerializersT, NullableT>
Inherited from CustomField.constructor
- Defined in packages/odata-common/dist/selectable/custom-field.d.ts:14

Properties

`Readonly`_entityConstructor

_entityConstructor: Constructable<EntityT>

`Readonly`_fieldName

_fieldName: string

`Readonly`_fieldOptions

_fieldOptions: Required<FieldOptions<NullableT, SelectableT>>

`Protected`fieldBuilder

fieldBuilder: FieldBuilder<Constructable<EntityT>, DeSerializersT>

Methods

edmBinary

edmBinary(): EdmTypeField<
    EntityT,
    DeSerializersT,
    "Edm.Binary",
    NullableT,
    true,
>
Returns EdmTypeField<EntityT, DeSerializersT, "Edm.Binary", NullableT, true>
Inherited from CustomField.edmBinary
- Defined in packages/odata-common/dist/selectable/custom-field.d.ts:27

edmBoolean

edmBoolean(): EdmTypeField<
    EntityT,
    DeSerializersT,
    "Edm.Boolean",
    NullableT,
    true,
>
Returns EdmTypeField<EntityT, DeSerializersT, "Edm.Boolean", NullableT, true>
Inherited from CustomField.edmBoolean
- Defined in packages/odata-common/dist/selectable/custom-field.d.ts:16

edmByte

edmByte(): OrderableEdmTypeField<
    EntityT,
    DeSerializersT,
    "Edm.Byte",
    NullableT,
    true,
>
Returns OrderableEdmTypeField<EntityT, DeSerializersT, "Edm.Byte", NullableT, true>
Inherited from CustomField.edmByte
- Defined in packages/odata-common/dist/selectable/custom-field.d.ts:24

edmDateTime

edmDateTime(): OrderableEdmTypeField<
    EntityT,
    DeSerializersT,
    "Edm.DateTime",
    NullableT,
    true,
>
Returns OrderableEdmTypeField<EntityT, DeSerializersT, "Edm.DateTime", NullableT, true>
- Defined in packages/odata-v2/dist/selectable/custom-field.d.ts:6

edmDateTimeOffset

edmDateTimeOffset(): OrderableEdmTypeField<
    EntityT,
    DeSerializersT,
    "Edm.DateTimeOffset",
    NullableT,
    true,
>
Returns OrderableEdmTypeField<
    EntityT,
    DeSerializersT,
    "Edm.DateTimeOffset",
    NullableT,
    true,
>
Inherited from CustomField.edmDateTimeOffset
- Defined in packages/odata-common/dist/selectable/custom-field.d.ts:26

edmDecimal

edmDecimal(): OrderableEdmTypeField<
    EntityT,
    DeSerializersT,
    "Edm.Decimal",
    NullableT,
    true,
>
Returns OrderableEdmTypeField<EntityT, DeSerializersT, "Edm.Decimal", NullableT, true>
Inherited from CustomField.edmDecimal
- Defined in packages/odata-common/dist/selectable/custom-field.d.ts:18

edmDouble

edmDouble(): OrderableEdmTypeField<
    EntityT,
    DeSerializersT,
    "Edm.Double",
    NullableT,
    true,
>
Returns OrderableEdmTypeField<EntityT, DeSerializersT, "Edm.Double", NullableT, true>
Inherited from CustomField.edmDouble
- Defined in packages/odata-common/dist/selectable/custom-field.d.ts:23

edmGuid

edmGuid(): EdmTypeField<EntityT, DeSerializersT, "Edm.Guid", NullableT, true>
Returns EdmTypeField<EntityT, DeSerializersT, "Edm.Guid", NullableT, true>
Inherited from CustomField.edmGuid
- Defined in packages/odata-common/dist/selectable/custom-field.d.ts:17

edmInt16

edmInt16(): OrderableEdmTypeField<
    EntityT,
    DeSerializersT,
    "Edm.Int16",
    NullableT,
    true,
>
Returns OrderableEdmTypeField<EntityT, DeSerializersT, "Edm.Int16", NullableT, true>
Inherited from CustomField.edmInt16
- Defined in packages/odata-common/dist/selectable/custom-field.d.ts:19

edmInt32

edmInt32(): OrderableEdmTypeField<
    EntityT,
    DeSerializersT,
    "Edm.Int32",
    NullableT,
    true,
>
Returns OrderableEdmTypeField<EntityT, DeSerializersT, "Edm.Int32", NullableT, true>
Inherited from CustomField.edmInt32
- Defined in packages/odata-common/dist/selectable/custom-field.d.ts:20

edmInt64

edmInt64(): OrderableEdmTypeField<
    EntityT,
    DeSerializersT,
    "Edm.Int64",
    NullableT,
    true,
>
Returns OrderableEdmTypeField<EntityT, DeSerializersT, "Edm.Int64", NullableT, true>
Inherited from CustomField.edmInt64
- Defined in packages/odata-common/dist/selectable/custom-field.d.ts:21

edmSByte

edmSByte(): OrderableEdmTypeField<
    EntityT,
    DeSerializersT,
    "Edm.SByte",
    NullableT,
    true,
>
Returns OrderableEdmTypeField<EntityT, DeSerializersT, "Edm.SByte", NullableT, true>
Inherited from CustomField.edmSByte
- Defined in packages/odata-common/dist/selectable/custom-field.d.ts:25

edmSingle

edmSingle(): OrderableEdmTypeField<
    EntityT,
    DeSerializersT,
    "Edm.Single",
    NullableT,
    true,
>
Returns OrderableEdmTypeField<EntityT, DeSerializersT, "Edm.Single", NullableT, true>
Inherited from CustomField.edmSingle
- Defined in packages/odata-common/dist/selectable/custom-field.d.ts:22

edmString

edmString(): EdmTypeField<
    EntityT,
    DeSerializersT,
    "Edm.String",
    NullableT,
    true,
>
Returns EdmTypeField<EntityT, DeSerializersT, "Edm.String", NullableT, true>
Inherited from CustomField.edmString
- Defined in packages/odata-common/dist/selectable/custom-field.d.ts:15

edmTime

edmTime(): OrderableEdmTypeField<
    EntityT,
    DeSerializersT,
    "Edm.Time",
    NullableT,
    true,
>
Returns OrderableEdmTypeField<EntityT, DeSerializersT, "Edm.Time", NullableT, true>
- Defined in packages/odata-v2/dist/selectable/custom-field.d.ts:7

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.

Copyright Ⓒ 2025 SAP SE or an SAP affiliate company. All rights reserved.
Inherited from CustomField.fieldPath
- Defined in packages/odata-common/dist/selectable/field.d.ts:54

Class CustomField<EntityT, DeSerializersT, NullableT>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns CustomField<EntityT, DeSerializersT, NullableT>

Properties

Readonly_entityConstructor

Readonly_fieldName

Readonly_fieldOptions

ProtectedfieldBuilder

Methods

edmBinary

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

edmBoolean

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

edmByte

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

edmDateTime

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

edmDateTimeOffset

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

edmDecimal

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

edmDouble

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

edmGuid

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

edmInt16

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

edmInt32

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

edmInt64

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

edmSByte

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

edmSingle

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

edmString

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

edmTime

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

fieldPath

Returns string

Settings

On This Page

`Readonly`_entityConstructor

`Readonly`_fieldName

`Readonly`_fieldOptions

`Protected`fieldBuilder

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