API Docs for:
Show:

StringFilterOptions Class

Extends FilterOptions
Defined in: odata-query-generator.js:423
Module: OData

String where clause filter class.

Methods

_cleanEndpointUrl

(
  • url
)
String private

Inherited from FilterOptions: odata-query-generator.js:154

Make sure there is a trailing /.

Parameters:

  • url String

    The endpoint url.

Returns:

String:

The cleaned endpoint url.

_extend

(
  • base
  • child
)
Function private

Inherited from FilterOptions: odata-query-generator.js:139

Gives the child object a copy of the parent object's prototype.

Parameters:

  • base Function

    The base method whose prototype will be copied.

  • child Function

    The child method who will get a copy of the parent's prototype.

Returns:

Function:

The augmented child method.

format

() private

Inherited from FilterOptions: odata-query-generator.js:125

Extend the built in String class with a format function.

getWhereQuery

(
  • propNames
  • operator
  • values
)
String

Inherited from FilterOptions but overwritten in odata-query-generator.js:446

Gets the where query for String objects.

Parameters:

  • propNames Array | String

    The list of property names.

  • operator String

    The type of comparator to perform.

  • values Array | String

    The value of the property.

Returns:

String:

A String query string.

init

(
  • options
)

Inherited from FilterOptions: odata-query-generator.js:184

Where clause filter base class init method.

Parameters:

  • options Object

    Options to set on each where filter.