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.

Type Parameters

DeSerializersT extends DeSerializers

Hierarchy

ODataUri

Index

Methods

convertToUriFormat getEntityKeys getExpand getFilter getOrderBy getResourcePathForKeys getSelect

Methods

convertToUriFormat

convertToUriFormat(value: any, edmType: EdmTypeCommon | ExclusiveEdmTypeV2 | ExclusiveEdmTypeV4): string
Parameters
- value: any
- edmType: EdmTypeCommon | ExclusiveEdmTypeV2 | ExclusiveEdmTypeV4
Returns string
- Defined in packages/odata-common/dist/uri-conversion/odata-uri.d.ts:28

getEntityKeys

getEntityKeys<EntityT>(entity: EntityT, entityApi: EntityApi<EntityT, DeSerializersT>): Record<string, any>
Type Parameters
- EntityT extends EntityBase<EntityT>
Parameters
- entity: EntityT
- entityApi: EntityApi<EntityT, DeSerializersT>
Returns Record<string, any>
- Defined in packages/odata-common/dist/uri-conversion/odata-uri.d.ts:20

getExpand

getExpand<EntityT>(selects: Selectable<EntityT, DeSerializersT>[], expands: Expandable<EntityT, DeSerializersT, EntityApi<EntityBase, DeSerializersT>>[], entityApi: EntityApi<EntityT, DeSerializersT>): Partial<{
expand: string;
}>
Type Parameters
- EntityT extends EntityBase<EntityT>
Parameters
- selects: Selectable<EntityT, DeSerializersT>[]
- expands: Expandable<EntityT, DeSerializersT, EntityApi<EntityBase, DeSerializersT>>[]
- entityApi: EntityApi<EntityT, DeSerializersT>
Returns Partial<{
expand: string;
}>
- Defined in packages/odata-common/dist/uri-conversion/odata-uri.d.ts:14

getFilter

getFilter<EntityT>(filter: Filterable<EntityT, DeSerializersT, EntityApi<EntityBase, any>>, entityApi: EntityApi<EntityT, DeSerializersT>): Partial<{
filter: string;
}>
Type Parameters
- EntityT extends EntityBase<EntityT>
Parameters
- filter: Filterable<EntityT, DeSerializersT, EntityApi<EntityBase, any>>
- entityApi: EntityApi<EntityT, DeSerializersT>
Returns Partial<{
filter: string;
}>
- Defined in packages/odata-common/dist/uri-conversion/odata-uri.d.ts:17

getOrderBy

getOrderBy<EntityT>(orderBy: Orderable<EntityT, EntityApi<EntityBase, DefaultDeSerializers>>[]): Partial<{
orderby: string;
}>
Type Parameters
- EntityT extends EntityBase<EntityT>
Parameters
- orderBy: Orderable<EntityT, EntityApi<EntityBase, DefaultDeSerializers>>[]
Returns Partial<{
orderby: string;
}>
- Defined in packages/odata-common/dist/uri-conversion/odata-uri.d.ts:21

getResourcePathForKeys

getResourcePathForKeys<EntityT>(keys: Record<string, any>, _entityApi: EntityApi<EntityT, DeSerializersT>): string
Type Parameters
- EntityT extends EntityBase<EntityT>
Parameters
- keys: Record<string, any>
- _entityApi: EntityApi<EntityT, DeSerializersT>
Returns string
- Defined in packages/odata-common/dist/uri-conversion/odata-uri.d.ts:24

getSelect

getSelect<EntityT>(selects: Selectable<EntityT, DeSerializersT>[]): Partial<{
select: string;
}>
Type Parameters
- EntityT extends EntityBase<EntityT>
Parameters
- selects: Selectable<EntityT, DeSerializersT>[]
Returns Partial<{
select: string;
}>
- Defined in packages/odata-common/dist/uri-conversion/odata-uri.d.ts:25

Interface ODataUri<DeSerializersT>

Type Parameters

DeSerializersT extends DeSerializers

Hierarchy

Index

Methods

Methods

convertToUriFormat

Parameters

value: any

edmType: EdmTypeCommon | ExclusiveEdmTypeV2 | ExclusiveEdmTypeV4

Returns string

getEntityKeys

Type Parameters

EntityT extends EntityBase<EntityT>

Parameters

entity: EntityT

entityApi: EntityApi<EntityT, DeSerializersT>

Returns Record<string, any>

getExpand

Type Parameters

EntityT extends EntityBase<EntityT>

Parameters

selects: Selectable<EntityT, DeSerializersT>[]

expands: Expandable<EntityT, DeSerializersT, EntityApi<EntityBase, DeSerializersT>>[]

entityApi: EntityApi<EntityT, DeSerializersT>

Returns Partial<{ expand: string; }>

getFilter

Type Parameters

EntityT extends EntityBase<EntityT>

Parameters

filter: Filterable<EntityT, DeSerializersT, EntityApi<EntityBase, any>>

entityApi: EntityApi<EntityT, DeSerializersT>

Returns Partial<{ filter: string; }>

getOrderBy

Type Parameters

EntityT extends EntityBase<EntityT>

Parameters

orderBy: Orderable<EntityT, EntityApi<EntityBase, DefaultDeSerializers>>[]

Returns Partial<{ orderby: string; }>

getResourcePathForKeys

Type Parameters

EntityT extends EntityBase<EntityT>

Parameters

keys: Record<string, any>

_entityApi: EntityApi<EntityT, DeSerializersT>

Returns string

getSelect

Type Parameters

EntityT extends EntityBase<EntityT>

Parameters

selects: Selectable<EntityT, DeSerializersT>[]

Returns Partial<{ select: string; }>

Settings

Member Visibility

Theme

Returns Partial<{
expand: string;
}>

Returns Partial<{
filter: string;
}>

Returns Partial<{
orderby: string;
}>

Returns Partial<{
select: string;
}>