Options
All
  • Public
  • Public/Protected
  • All
Menu

Class FilterFunction<EntityT, ReturnT>

Data structure to represent OData V2 filter functions. Use the factory function filterFunction to create instances of FilterFunction.

Type parameters

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

  • Creates an instance of FilterFunction.

    Parameters

    • functionName: string

      Name of the function

    • parameters: Array<FilterFunctionParameterType<EntityT>>

      Representation of the parameters passed to the filter function

    Returns FilterFunction

Properties

edmType

edmType: EdmType

EdmType of the return type of the filter function.

functionName

functionName: string

Name of the function

parameters

parameters: Array<FilterFunctionParameterType<EntityT>>

Representation of the parameters passed to the filter function

Methods

equals

  • equals(value: ReturnT): Filter<EntityT, ReturnT>

  • Creates an instance of Filter for this filter function and the given value using the operator 'eq', i.e. ==.

    Parameters

    • value: ReturnT

      Value to be used in the filter

    Returns Filter<EntityT, ReturnT>

    The resulting filter

notEquals

  • notEquals(value: ReturnT): Filter<EntityT, ReturnT>

  • Creates an instance of Filter for this filter function and the given value using the operator 'ne', i.e. !=.

    Parameters

    • value: ReturnT

      Value to be used in the filter

    Returns Filter<EntityT, ReturnT>

    The resulting filter

toString

  • toString(parentFieldNames?: string[]): string

  • Serializes the filter function into a string

    Parameters

    • Default value parentFieldNames: string[] = []

      Names of parents in case the function is part of a filter on a navigation property

    Returns string

    The filter function as string