Class ODataFilter<T>

OData filter builder

Type Parameters

T = any

Hierarchy

ODataFilter
- ParamBoundedFilter

Index

Constructors

constructor

new ODataFilter<T>(): ODataFilter<T>
Type Parameters
- T = any
Returns ODataFilter<T>

Properties

`Private` _fieldExprMappings

_fieldExprMappings: FieldExprMappings = {}

Methods

`Protected` _buildFieldExprString

_buildFieldExprString(field): string
Parameters
- field: string
Returns string
- Defined in filter.ts:420

betweenDateTime

betweenDateTime(name, start, end): ODataFilter<T>
Parameters
- name: keyof T
- start: Date
- end: Date
Returns ODataFilter<T>

Deprecated
- Defined in filter.ts:350

betweenDateTimeOffset

betweenDateTimeOffset(name, start, end): ODataFilter<any>
Parameters
- name: keyof T
- start: Date
- end: Date
Returns ODataFilter<any>

Deprecated
- Defined in filter.ts:364

build

build(): string
build filter to string

Returns string
- Defined in filter.ts:443

field

field(name): ODataPropertyExpr<ODataFilter<T>>
filter property
Parameters
- name: keyof T
  
  field name or function expression
Returns ODataPropertyExpr<ODataFilter<T>>

See
property
- Defined in filter.ts:288

fieldIn

fieldIn(name, values): ODataFilter<T>
The value of a field matches any value in the list.
Parameters
- name: keyof T
- values: string[]
Returns ODataFilter<T>

Deprecated
please use filter.field().in()
- Defined in filter.ts:309

fieldValueMatchArray

fieldValueMatchArray(name, values?): ODataFilter<T>
The value of a field matches any value in the list.
Parameters
- name: keyof T
- values: string[] = []
Returns ODataFilter<T>

Deprecated
please use filter.field().in()
- Defined in filter.ts:321

`Private` getExprMapping

getExprMapping(): FieldExprMappings
Private Internal
getExprMapping

Returns FieldExprMappings
- Defined in filter.ts:279

group

group(filter): ODataFilter<T>
Parameters
- filter: ODataFilter<any>
Returns ODataFilter<T>

Deprecated
c4codata will auto group exprs
- Defined in filter.ts:411

gtDateTime

gtDateTime(name, date): ODataFilter<T>
Parameters
- name: keyof T
- date: Date
Returns ODataFilter<T>

Deprecated
- Defined in filter.ts:376

gtDateTimeOffset

gtDateTimeOffset(name, date): ODataFilter<T>
Parameters
- name: keyof T
- date: Date
Returns ODataFilter<T>

Deprecated
- Defined in filter.ts:385

inPeriod

inPeriod(name, start, end): ODataFilter<T>
DEPRECATED

please use betweenDateTime/betweenDateTimeOffset
Parameters
- name: keyof T
- start: Date
- end: Date
Returns ODataFilter<T>

Deprecated
- Defined in filter.ts:340

ltDateTime

ltDateTime(name, date): ODataFilter<T>
Parameters
- name: keyof T
- date: Date
Returns ODataFilter<T>

Deprecated
- Defined in filter.ts:394

ltDateTimeOffset

ltDateTimeOffset(name, date): ODataFilter<T>
Parameters
- name: keyof T
- date: Date
Returns ODataFilter<T>

Deprecated
- Defined in filter.ts:403

property

property(name): ODataPropertyExpr<ODataFilter<T>>
filter property
Parameters
- name: keyof T
  
  property name
Returns ODataPropertyExpr<ODataFilter<T>>
- Defined in filter.ts:297

toString

toString(): string
Returns string
- Defined in filter.ts:416

`Static` newBuilder

newBuilder<T>(): ODataFilter<T>
Type Parameters
- T = any
Returns ODataFilter<T>
- Defined in filter.ts:260

`Static` newFilter

newFilter<T>(): ODataFilter<T>
construct a new filter
Type Parameters
- T = any
Returns ODataFilter<T>
- Defined in filter.ts:267

Generated using TypeDoc