Class ODataQueryParam<T>

OData Param Object

ref https://github.com/SAP/C4CODATAAPIDEVGUIDE

Type parameters

T = any

Hierarchy

ODataQueryParam

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ODataQueryParam<T>(): ODataQueryParam<T>

Type parameters
- T = any
Returns ODataQueryParam<T>

Properties

Private $count

$count: boolean = false

Private $expand

$expand: string[] = ...

Private $filter

$filter: string | ODataFilter

Private $format

$format: "json" | "xml" = 'json'

Private $inlinecount

$inlinecount: string

Private $orderby

$orderby: string

Private $search

$search: string

Private $select

$select: string[] = ...

Private $skip

$skip: number = 0

Private $top

$top: number = 0

Methods

count

count(count?: boolean): ODataQueryParam<any>

- Defined in build/repo/src/params.ts:70
count items in odata v4

version

4.0.0

Parameters
- count: boolean = true
Returns ODataQueryParam<any>

expand

expand(fields: keyof T | keyof T[], replace?: boolean): ODataQueryParam<T>

- Defined in build/repo/src/params.ts:184
expand navigation props

Parameters
- fields: keyof T | keyof T[]
- replace: boolean = false
Returns ODataQueryParam<T>

filter

filter(filter?: string | ODataFilter<any>): ODataQueryParam<T>

- Defined in build/repo/src/params.ts:80
apply filter for query

Parameters
- Optional filter: string | ODataFilter<any>
Returns ODataQueryParam<T>

format

format(format: "json" | "xml"): ODataQueryParam<T>

- Defined in build/repo/src/params.ts:156
result format, please keep it as json

Parameters
- format: "json" | "xml"
  
  deafult json
Returns ODataQueryParam<T>

inlinecount

inlinecount(inlinecount?: boolean): ODataQueryParam<any>

- Defined in build/repo/src/params.ts:53
with $inlinecount value

version

2.0.0

Parameters
- inlinecount: boolean = false
Returns ODataQueryParam<any>

orderby

orderby(fieldOrOrders: keyof T | ODataParamOrderField<T>[], order?: "asc" | "desc"): ODataQueryParam<T>

- Defined in build/repo/src/params.ts:129
set order sequence

Parameters
- fieldOrOrders: keyof T | ODataParamOrderField<T>[]
- order: "asc" | "desc" = 'desc'
  
  default desc, disabled when first params is array
Returns ODataQueryParam<T>

orderbyMulti

orderbyMulti(fields?: ODataParamOrderField<T>[]): ODataQueryParam<T>

- Defined in build/repo/src/params.ts:146
set order by multi field

Parameters
- fields: ODataParamOrderField<T>[] = ...
Returns ODataQueryParam<T>

search

search(value: string, fuzzy?: boolean): ODataQueryParam<T>

- Defined in build/repo/src/params.ts:173
full text search

default with fuzzy search, SAP system or OData V4 only

version

4.0.0

Parameters
- value: string
- fuzzy: boolean = true
Returns ODataQueryParam<T>

select

select(selects: keyof T | keyof T[]): ODataQueryParam<T>

- Defined in build/repo/src/params.ts:118
select viewed fields

Parameters
- selects: keyof T | keyof T[]
Returns ODataQueryParam<T>

skip

skip(skip: number): ODataQueryParam<T>

- Defined in build/repo/src/params.ts:96
skip first records

Parameters
- skip: number
Returns ODataQueryParam<T>

toString

toString(version?: ODataVersion): string

- Defined in build/repo/src/params.ts:199
Parameters
- version: ODataVersion = 'v2'
Returns string

top

top(top: number): ODataQueryParam<T>

- Defined in build/repo/src/params.ts:107
limit result max records

Parameters
- top: number
Returns ODataQueryParam<T>

Static newParam

newParam(): ODataQueryParam<any>

- Defined in build/repo/src/params.ts:33
Returns ODataQueryParam<any>

Generated using TypeDoc