Fork me on GitHub
Show:

FilterCollection

Extends aeris.Collection

Summary

Represents a set of filters to include in a request to the AerisAPI

Constructor

aeris.api.params.collections.FilterCollection

Syntax

aeris.api.params.collections.FilterCollection

(
  • opt_options.validFilters
)

Summary

Parameters:

  • opt_options.validFilters Array.<string>

    A list of valid filters.

Methods

add

Syntax

add

(
  • filters
  • opt_options
)

Summary

Provides an alternate syntax for aeris.Collection#add, which allows adding filters by name.

eg. filters.add('sieve', 'colander', { operator: aeris.api.Operator.OR });

Parameters:

addFiltersByName_

Syntax

addFiltersByName_

(
  • filters
  • options
)
private

Summary

Adds a filter or array of filters by name, or delegates to aeris.Collection#add or aeris.Collection#reset

Parameters:

operatorToString_

Syntax

operatorToString_

(
  • operator
)
String private

Summary

Encodes an {aeris.api.Operator} to be used in an AerisApi query request. See http://www.hamweather.com/support/documentation/aeris/queries/.

Parameters:

Returns:

remove

Syntax

remove

(
  • filters
)

Summary

Allows to remove filters by name, in addition to standard aeris.Collection#remove syntax.

Parameters:

reset

Syntax

reset

(
  • filters
  • opt_options
)

Summary

Provides an alternate syntax for aeris.Collection#reset, which allows adding filters by name.

eg. filters.reset('sieve', 'colander', { operator: aeris.api.Operator.AND });

Parameters:

toString

Syntax

toString

()

Summary

Prepares the filtercollection to be used as for the filter parameters in a Aeris API request query string.