Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ODataFilter<T>

OData filter builder

Type parameters

  • T = any

Hierarchy

  • ODataFilter

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Private _fieldExprMappings

_fieldExprMappings: FieldExprMappings = ...

Methods

Protected _buildFieldExprString

  • _buildFieldExprString(field: string): string

  • Parameters

    • field: string

    Returns string

and

  • AND expr

    filter.field("A").eq("'a'").and().field("B").eq("'b").build() == "A eq 'a' and B eq 'b'"

    filter.field("A").eq("'a'").and("B eq 'b'").build() == "A eq 'a' and (B eq 'b')"

    deprecated

    c4codata will auto detect logic operator between difference fields

    Parameters

    Returns ODataFilter<any>

betweenDateTime

  • betweenDateTime(name: keyof T, start: Date, end: Date): ODataFilter<any>
  • deprecated

    Parameters

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

    Returns ODataFilter<any>

betweenDateTimeOffset

  • betweenDateTimeOffset(name: keyof T, start: Date, end: Date): ODataFilter<any>
  • deprecated

    Parameters

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

    Returns ODataFilter<any>

build

  • build(): string

  • Returns string

field

  • field(name: keyof T): ODataFieldExpr

  • Parameters

    • name: keyof T

      field name or function expression

    Returns ODataFieldExpr

fieldIn

  • fieldIn(name: keyof T, values: string[]): ODataFilter<T>

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

    deprecated

    please use filter.field().in()

    Parameters

    • name: keyof T
    • values: string[]

    Returns ODataFilter<T>

fieldValueMatchArray

  • fieldValueMatchArray(name: keyof T, values?: string[]): ODataFilter<T>

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

    deprecated

    please use filter.field().in()

    Parameters

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

    Returns ODataFilter<T>

Private getExprMapping

  • getExprMapping(): FieldExprMappings

  • getExprMapping

    internal

    Returns FieldExprMappings

group

  • deprecated

    c4codata will auto group exprs

    Parameters

    Returns ODataFilter<any>

gtDateTime

  • gtDateTime(name: keyof T, date: Date): ODataFilter<any>
  • deprecated

    Parameters

    • name: keyof T
    • date: Date

    Returns ODataFilter<any>

gtDateTimeOffset

  • gtDateTimeOffset(name: keyof T, date: Date): ODataFilter<any>
  • deprecated

    Parameters

    • name: keyof T
    • date: Date

    Returns ODataFilter<any>

inPeriod

  • inPeriod(name: keyof T, start: Date, end: Date): ODataFilter<any>

  • DEPRECATED

    please use betweenDateTime/betweenDateTimeOffset

    deprecated

    Parameters

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

    Returns ODataFilter<any>

ltDateTime

  • ltDateTime(name: keyof T, date: Date): ODataFilter<any>
  • deprecated

    Parameters

    • name: keyof T
    • date: Date

    Returns ODataFilter<any>

ltDateTimeOffset

  • ltDateTimeOffset(name: keyof T, date: Date): ODataFilter<any>
  • deprecated

    Parameters

    • name: keyof T
    • date: Date

    Returns ODataFilter<any>

or

  • deprecated

    c4codata will auto detect logic operator in same fields

    Parameters

    Returns ODataFilter<any>

toString

  • toString(): string

  • Returns string

Static newBuilder

  • Returns ODataFilter<any>

Static newFilter

  • construct a new filter

    Returns ODataFilter<any>

Generated using TypeDoc