Class ODataFilter<T>

OData filter builder

Type Parameters

  • T = any

Hierarchy (view full)

Constructors

constructor

Properties

_fieldExprMappings

Methods

_buildFieldExprString betweenDateTime betweenDateTimeOffset build field fieldIn fieldValueMatchArray getExprMapping group gtDateTime gtDateTimeOffset inPeriod ltDateTime ltDateTimeOffset property toString newBuilder newFilter

Constructors

constructor

Properties

Private _fieldExprMappings

_fieldExprMappings: FieldExprMappings = {}

Methods

Protected _buildFieldExprString

  • _buildFieldExprString(field): string

  • Parameters

    • field: string

    Returns string

betweenDateTime

  • betweenDateTime(name, start, end): this

  • Parameters

    • name: keyof T
    • start: Date
    • end: Date

    Returns this

    Deprecated

betweenDateTimeOffset

build

  • build(): string

  • build filter to string

    Returns string

field

  • field(name): ODataPropertyExpr<ODataFilter<T>>

  • filter property

    Parameters

    • name: keyof T

      field name or function expression

    Returns ODataPropertyExpr<ODataFilter<T>>

    See

    property

fieldIn

  • fieldIn(name, values): this

  • The value of a field matches any value in the list.

    Parameters

    • name: keyof T
    • values: string[]

    Returns this

    Deprecated

    please use filter.field().in()

fieldValueMatchArray

  • fieldValueMatchArray(name, values?): this

  • The value of a field matches any value in the list.

    Parameters

    • name: keyof T
    • values: string[] = []

    Returns this

    Deprecated

    please use filter.field().in()

Private getExprMapping

  • getExprMapping(): FieldExprMappings
  • Private Internal

    getExprMapping

    Returns FieldExprMappings

group

  • group(filter): this

  • Parameters

    Returns this

    Deprecated

    c4codata will auto group exprs

gtDateTime

  • gtDateTime(name, date): this

  • Parameters

    • name: keyof T
    • date: Date

    Returns this

    Deprecated

gtDateTimeOffset

  • gtDateTimeOffset(name, date): this

  • Parameters

    • name: keyof T
    • date: Date

    Returns this

    Deprecated

inPeriod

  • inPeriod(name, start, end): this

  • DEPRECATED

    please use betweenDateTime/betweenDateTimeOffset

    Parameters

    • name: keyof T
    • start: Date
    • end: Date

    Returns this

    Deprecated

ltDateTime

  • ltDateTime(name, date): this

  • Parameters

    • name: keyof T
    • date: Date

    Returns this

    Deprecated

ltDateTimeOffset

  • ltDateTimeOffset(name, date): this

  • Parameters

    • name: keyof T
    • date: Date

    Returns this

    Deprecated

property

toString

Static newBuilder

Static newFilter

Settings

Member Visibility

Theme

On This Page

constructor_fieldExprMappings_buildFieldExprStringbetweenDateTimebetweenDateTimeOffsetbuildfieldfieldInfieldValueMatchArraygetExprMappinggroupgtDateTimegtDateTimeOffsetinPeriodltDateTimeltDateTimeOffsetpropertytoStringnewBuildernewFilter