Interface ODataUri<DeSerializersT>

Union of necessary methods for the OData URI conversion. In v2/uri-conversion/odata-uri.ts and v4/uri-conversion/odata-uri.ts the instance for v2 and v4 are created.

interface ODataUri<DeSerializersT> {
    convertToUriFormat(value: any, edmType: EdmTypeCommon | ExclusiveEdmTypeV2 | ExclusiveEdmTypeV4): string;
    getEntityKeys<EntityT>(entity: EntityT, entityApi: EntityApi<EntityT, DeSerializersT>): Record<string, any>;
    getExpand<EntityT>(selects: Selectable<EntityT, DeSerializersT>[], expands: Expandable<EntityT, DeSerializersT>[], entityApi: EntityApi<EntityT, DeSerializersT>): Partial<{
        expand: string;
    }>;
    getFilter<EntityT>(filter: Filterable<EntityT, DeSerializersT>, entityApi: EntityApi<EntityT, DeSerializersT>): Partial<{
        filter: string;
    }>;
    getOrderBy<EntityT>(orderBy: Orderable<EntityT>[]): Partial<{
        orderby: string;
    }>;
    getResourcePathForKeys<EntityT>(keys: Record<string, any>, _entityApi: EntityApi<EntityT, DeSerializersT>): string;
    getSelect<EntityT>(selects: Selectable<EntityT, DeSerializersT>[]): Partial<{
        select: string;
    }>;
}

Type Parameters

Methods

convertToUriFormat getEntityKeys getExpand getFilter getOrderBy getResourcePathForKeys getSelect

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

Methods

convertToUriFormat

getEntityKeys

  • getEntityKeys<EntityT>(entity, entityApi): Record<string, any>

  • Type Parameters

    Parameters

    Returns Record<string, any>

getExpand

getFilter

getOrderBy

  • getOrderBy<EntityT>(orderBy): Partial<{
        orderby: string;
    }>

  • Type Parameters

    Parameters

    Returns Partial<{
        orderby: string;
    }>

getResourcePathForKeys

  • getResourcePathForKeys<EntityT>(keys, _entityApi): string

  • Type Parameters

    Parameters

    Returns string

getSelect

  • getSelect<EntityT>(selects): Partial<{
        select: string;
    }>

  • Type Parameters

    Parameters

    Returns Partial<{
        select: string;
    }>

Settings

Member Visibility

On This Page

Methods