Class OneToOneLink<EntityT, DeSerializersT, LinkedEntityApiT>

constructor

• new OneToOneLink<
      EntityT extends EntityBase,
      DeSerializersT extends
          DeSerializers<
              any,
              any,
              any,
              any,
              any,
              any,
              any,
              any,
              any,
              any,
              any,
              any,
              any,
              any,
          >,
      LinkedEntityApiT extends EntityApi<EntityBase, DeSerializersT>,
  >(
      _fieldName: string,
      _entityApi: EntityApi<EntityT, DeSerializersT>,
      _linkedEntityApi: LinkedEntityApiT,
  ): OneToOneLink<EntityT, DeSerializersT, LinkedEntityApiT>

  Creates an instance of Link.

  Type Parameters

  • EntityT extends EntityBase
  • DeSerializersT extends DeSerializers<
        any,
        any,
        any,
        any,
        any,
        any,
        any,
        any,
        any,
        any,
        any,
        any,
        any,
        any,
    >
  • LinkedEntityApiT extends EntityApi<EntityBase, DeSerializersT>

  Parameters

  • _fieldName: string

    Name of the linking field to be used in the OData request.
  • _entityApi: EntityApi<EntityT, DeSerializersT>

    Entity API for building and executing the request.
  • _linkedEntityApi: LinkedEntityApiT

    Constructor of the linked entity.

  Returns OneToOneLink<EntityT, DeSerializersT, LinkedEntityApiT>

filters

orderBys

clone

• clone(): this

  Create a new link based on a given link.

  Returns this

  Newly created link.

filter

• filter(
      ...filters: Filterable<EntityType<LinkedEntityApiT>, DeSerializersT>[],
  ): FilterLink<EntityT, DeSerializersT, LinkedEntityApiT>

  Create filter statements to be applied to the OData request based on the linked entity values.

  Parameters

  • ...filters: Filterable<EntityType<LinkedEntityApiT>, DeSerializersT>[]

    Filters based on the linked entity.

  Returns FilterLink<EntityT, DeSerializersT, LinkedEntityApiT>

  Newly created FilterLink.

orderBy

• orderBy(
      ...orderBy: Orderable<EntityType<LinkedEntityApiT>>[],
  ): OrderLink<EntityT, LinkedEntityApiT>

  Create order statements for the OData request based on the linked entity. The given statements have descending priority.

  Parameters

  • ...orderBy: Orderable<EntityType<LinkedEntityApiT>>[]

    Criteria to order by.

  Returns OrderLink<EntityT, LinkedEntityApiT>

  Newly created order link.

  Example

  Entity.requestBuilder()
   .getAll()
   .orderBy(Entity.TO_LINKED_ENTITY.orderBy(asc(LinkedEntity.PROPERTY1), desc(LinkedEntity.PROPERTY2)));
  Copy