Class SystemQueryOptions<T>

OData System Query Options

like $filter, $format, $top ....

Type Parameters

T = any

Index

Constructors

Properties

#customParams $apply $count $expand $filter $format $inlinecount $orderby $search $select $skip $top

Methods

apply count custom expand filter format inlinecount orderby orderbyMulti search select skip toString top newOptions newParam

Constructors

constructor

new SystemQueryOptions<T>(): SystemQueryOptions<T>
Type Parameters
- T = any
Returns SystemQueryOptions<T>
- Defined in params.ts:47

Properties

`Private` #customParams

#customParams: SearchParams

`Private` $apply

$apply: string

`Private` $count

$count: boolean = false

`Private` $expand

$expand: string[] = []

`Private` $filter

$filter: string | ODataFilter<any>

`Private` $format

$format: "json" | "xml"

`Private` $inlinecount

$inlinecount: string

`Private` $orderby

$orderby: string

`Private` $search

$search: string

`Private` $select

$select: string[] = []

`Private` $skip

$skip: number

`Private` $top

$top: number

Methods

apply

apply(expression): SystemQueryOptions<T>
Experimental
apply data aggregation
Parameters
- expression: Transformation[]
Returns SystemQueryOptions<T>
See
OData Extension for Data Aggregation Version 4.0
- Defined in params.ts:223
apply(expression): SystemQueryOptions<T>
Parameters
- expression: Transformation
Returns SystemQueryOptions<T>
- Defined in params.ts:225
apply(expression): SystemQueryOptions<T>
Parameters
- expression: string[]
Returns SystemQueryOptions<T>
- Defined in params.ts:227
apply(expression): SystemQueryOptions<T>
Parameters
- expression: string
Returns SystemQueryOptions<T>
- Defined in params.ts:229

count

count(count?): SystemQueryOptions<T>
count items in odata v4
Parameters
- count: boolean = true
Returns SystemQueryOptions<T>
Version
4.0.0
- Defined in params.ts:97

custom

custom(key, value): SystemQueryOptions<T>
add addtional custom properties in final url query
Parameters
- key: any
  addtional url query parameter key
- value: any
  value
Returns SystemQueryOptions<T>
Example
```
OData.newParam().
```
- Defined in params.ts:282

expand

expand(fields, replace?): SystemQueryOptions<T>
expand navigation props
Parameters
- fields: keyof T | (keyof T)[]
- replace: boolean = false
Returns SystemQueryOptions<T>
- Defined in params.ts:255

filter

filter(): ParamBoundedFilter<any>
apply filter for query

Returns ParamBoundedFilter<any>
- Defined in params.ts:108
filter(filter): SystemQueryOptions<T>
Parameters
- filter: string | ODataFilter<any>
Returns SystemQueryOptions<T>
- Defined in params.ts:110

format

format(format): SystemQueryOptions<T>
result format, please keep it as json
Parameters
- format: "json" | "xml"
  deafult json
Returns SystemQueryOptions<T>
- Defined in params.ts:192

inlinecount

inlinecount(inlinecount?): SystemQueryOptions<T>
with $inlinecount value
Parameters
- inlinecount: boolean = false
Returns SystemQueryOptions<T>
Version
2.0.0
- Defined in params.ts:80

orderby

orderby(fieldOrOrders, order?): SystemQueryOptions<T>
set order sequence
Parameters
- fieldOrOrders: keyof T | ODataParamOrderField<T>[]
- order: "desc" | "asc" = "desc"
  default desc, disabled when first params is array
Returns SystemQueryOptions<T>
- Defined in params.ts:165

orderbyMulti

orderbyMulti(fields?): SystemQueryOptions<T>
set order by multi field
Parameters
- fields: ODataParamOrderField<T>[] = []
Returns SystemQueryOptions<T>
- Defined in params.ts:182

search

search(value, fuzzy?): SystemQueryOptions<T>
full text search

default with fuzzy search, SAP system or OData V4 only
Parameters
- value: string
- fuzzy: boolean = true
Returns SystemQueryOptions<T>
Version
4.0.0
- Defined in params.ts:209

select

select(selects): SystemQueryOptions<T>
select viewed fields
Parameters
- selects: keyof T | (keyof T)[]
Returns SystemQueryOptions<T>
- Defined in params.ts:154

skip

skip(skip): SystemQueryOptions<T>
skip first records
Parameters
- skip: number
Returns SystemQueryOptions<T>
- Defined in params.ts:132

toString

toString(version?, variant?): string
convert param object to query string
Parameters
- version: ODataVersion = "v2"
- variant: ODataVariant = "default"
Returns string
- Defined in params.ts:295

top

top(top): SystemQueryOptions<T>
limit result max records
Parameters
- top: number
Returns SystemQueryOptions<T>
- Defined in params.ts:143

`Static` newOptions

newOptions<T>(): SystemQueryOptions<T>
Type Parameters
- T = any
Returns SystemQueryOptions<T>
- Defined in params.ts:43

`Static` newParam

newParam<T>(): SystemQueryOptions<T>
Type Parameters
- T = any
Returns SystemQueryOptions<T>
Deprecated
- Defined in params.ts:39

Generated using TypeDoc