Class EntityBuilder<EntityT, DeSerializersT>

Contains the methods to build an entity.

Type Parameters

Hierarchy

  • EntityBuilder

Constructors

constructor

Properties

_entity _entityApi

Methods

build fromJson withCustomFields

Constructors

constructor

  • Type Parameters

    • EntityT extends EntityBase<EntityT>

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

    Parameters

    • _entityApi: EntityApi<EntityT, DeSerializersT>

    Returns EntityBuilder<EntityT, DeSerializersT>

Properties

Protected _entity

_entity: EntityT

Readonly _entityApi

_entityApi: EntityApi<EntityT, DeSerializersT>

Methods

build

  • Builds the entity.

    Returns

    The entity.

    Returns EntityT

fromJson

  • Builds an entity from JSON representation. If you have obtained the JSON object as a request payload use the entityDeserializer methods. Note that fields not mappable to a field in the target entity are silently ignored.

    Returns

    EntityBase constructed from JSON representation.

    Parameters

    • json: FromJsonType<EntityT>

      Representation of the entity in JSON format.

    Returns EntityT

withCustomFields

  • Sets the custom fields for the entity.

    Returns

    The entity builder itself for method chaining.

    Parameters

    • customFields: Record<string, any>

      The custom fields you want to add.

    Returns EntityBuilder<EntityT, DeSerializersT>

Settings

Member Visibility

Theme

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