Share via


ComparisonFilter interface

A filter used to compare a specified attribute key to a given value using a defined comparison operation.

Properties

key

The key to compare against the value.

type

Specifies the comparison operator: eq, ne, gt, gte, lt, lte, in, nin.

  • eq: equals
  • ne: not equal
  • gt: greater than
  • gte: greater than or equal
  • lt: less than
  • lte: less than or equal
  • in: in
  • nin: not in
value

The value to compare against the attribute key; supports string, number, or boolean types.

Property Details

key

The key to compare against the value.

key: string

Property Value

string

type

Specifies the comparison operator: eq, ne, gt, gte, lt, lte, in, nin.

  • eq: equals
  • ne: not equal
  • gt: greater than
  • gte: greater than or equal
  • lt: less than
  • lte: less than or equal
  • in: in
  • nin: not in
type: "eq" | "ne" | "gt" | "gte" | "lt" | "lte"

Property Value

"eq" | "ne" | "gt" | "gte" | "lt" | "lte"

value

The value to compare against the attribute key; supports string, number, or boolean types.

value: string | number | boolean | ComparisonFilterValueItems[]

Property Value

string | number | boolean | ComparisonFilterValueItems[]