Interface EntitySerializer

Interface representing the return type of the builder function entitySerializer.

interface EntitySerializer {
    serializeComplexType: (<ComplexTypeNamespaceT>(fieldValue, complexTypeNameSpace) => any);
    serializeEntity: (<EntityT>(entity, entityApi, diff?) => Record<string, any>);
    serializeEntityNonCustomFields: (<EntityT>(entity, entityApi) => Record<string, any>);
}

Index

Properties

serializeComplexType serializeEntity serializeEntityNonCustomFields

Properties

serializeComplexType

serializeComplexType: (<ComplexTypeNamespaceT>(fieldValue, complexTypeNameSpace) => any)

Method to serialize a complex type to JSON.

Type declaration

- <ComplexTypeNamespaceT>(fieldValue, complexTypeNameSpace): any
- Type Parameters
  - ComplexTypeNamespaceT extends ComplexTypeNamespace<any> = any
  Parameters
  - fieldValue: any
  - complexTypeNameSpace: ComplexTypeNamespaceT
  Returns any

serializeEntity

serializeEntity: (<EntityT>(entity, entityApi, diff?) => Record<string, any>)

Converts an instance of an entity class into a JSON payload to be sent to an OData service.

Type declaration

- <EntityT>(entity, entityApi, diff?): Record<string, any>
- Type Parameters
  - EntityT extends EntityBase
  Parameters
  - entity: EntityT
  - entityApi: EntityApi<EntityT, any>
  - Optional diff: boolean
  Returns Record<string, any>

serializeEntityNonCustomFields

serializeEntityNonCustomFields: (<EntityT>(entity, entityApi) => Record<string, any>)

Like EntitySerializer#serializeEntity ignoring custom fields.

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

Type declaration

- <EntityT>(entity, entityApi): Record<string, any>
- Type Parameters
  - EntityT extends EntityBase
  Parameters
  - entity: EntityT
  - entityApi: EntityApi<EntityT, any>
  Returns Record<string, any>