Skip to main content

ODataBuilder

Builder for ODataConfig

Methods​

build()​

build(): object

Build ODataConfig

Returns​

  • ODataConfig with all changes from ODataBuilder methods
count?​

optional count: boolean

expands​

expands: string[]

filters​

filters: BaseODataFilter<unknown>[]

orderBys​

orderBys: ODataOrderBy[]

selects​

selects: string[]

skip?​

optional skip: number

Number of records to skip

top?​

optional top: number

Number of records to return

count()​

count(): ODataBuilder

Record count

Returns​

ODataBuilder

expand()​

expand(value): ODataBuilder

Add expanded property

Parameters​

value​

string

property to expand

Returns​

ODataBuilder

expandMany()​

expandMany(value): ODataBuilder

Add expanded properties

Parameters​

value​

string[]

properties to expand

Returns​

ODataBuilder

filter()​

filter(leftSide, rightSide, operator?, options?): ODataBuilder

Filter request

Parameters​

leftSide​

string

property to filter

rightSide​

unknown

data to filter by

operator?​

string

(optional) filter operator ODataOperator

options?​

ODataFilterOptions

(optional) filter options ODataFilterOptions

Returns​

ODataBuilder

filterString()​

filterString(leftSide, rightSide, operator?, options?): ODataBuilder

Filter for string type

Parameters​

leftSide​

string

property to filter

rightSide​

string

data to filter by

operator?​

string

(optional) filter operator ODataOperator

options?​

ODataFilterOptions

(optional) filter options ODataFilterOptions

Returns​

ODataBuilder

filterUuid()​

filterUuid(leftSide, rightSide, operator?, options?): ODataBuilder

Filter for Uuid type

Parameters​

leftSide​

string

property to filter

rightSide​

string

data to filter by

operator?​

string

(optional) filter operator ODataOperator

options?​

ODataFilterOptions

(optional) filter options ODataFilterOptions

Returns​

ODataBuilder

orderBy()​

orderBy(propertyName, direction, priority?): ODataBuilder

Set order options

Parameters​

propertyName​

string

name of property

direction​

ODataOrderByDirection

direction of order

priority?​

number

priority of order

Returns​

ODataBuilder

select()​

select(value): ODataBuilder

Limit selected properties

Parameters​

value​

string

selected property

Returns​

ODataBuilder

selectArray()​

selectArray(value): ODataBuilder

Limit selected properties in an array

Parameters​

value​

string[]

array of properties

Returns​

ODataBuilder

selectMany()​

selectMany(value): ODataBuilder

Limit selected properties in an object

Parameters​

value​

WithIndexer<string[]>

object with selected properties

Returns​

ODataBuilder

skip()​

skip(value): ODataBuilder

Skip a number of records

Parameters​

value​

number

number of records to skip

Returns​

ODataBuilder

top()​

top(value): ODataBuilder

Set number of records to return

Parameters​

value​

number

number of records

Returns​

ODataBuilder