Options
All
  • Public
  • Public/Protected
  • All
Menu

Class FilterQueryOp

FilterQueryOp is an 'Enum' containing all of the valid Predicate filter operators for an EntityQuery.

Hierarchy

Implements

Index

Constructors

constructor

Properties

_$typeName

_$typeName: string

Type of the enum; set in prototype of each enum

name

name: string

The name of this symbol

operator

operator: string

The operator for this enum.

Static All

All: FilterQueryOp = new FilterQueryOp({ operator: "all" })

Aliases: "every"

Static Any

Any: FilterQueryOp = new FilterQueryOp({ operator: "any" })

Aliases: "some"

Static Contains

Contains: FilterQueryOp = new FilterQueryOp({ operator: "contains" })

String operation: Is a string a substring of another string. Aliases: "substringof"

Static EndsWith

EndsWith: FilterQueryOp = new FilterQueryOp({ operator: "endswith" })

No aliases

Static Equals

Equals: FilterQueryOp = new FilterQueryOp({ operator: "eq" })

Aliases: "eq", "=="

Static GreaterThan

GreaterThan: FilterQueryOp = new FilterQueryOp({ operator: "gt" })

Aliases: "gt", ">"

Static GreaterThanOrEqual

GreaterThanOrEqual: FilterQueryOp = new FilterQueryOp({ operator: "ge" })

Aliases: "ge", ">="

Static In

In: FilterQueryOp = new FilterQueryOp({ operator: "in" })

No aliases

Static IsTypeOf

IsTypeOf: FilterQueryOp = new FilterQueryOp({ operator: "isof" })

No aliases

Static LessThan

LessThan: FilterQueryOp = new FilterQueryOp({ operator: "lt" })

Aliases: "lt", "<"

Static LessThanOrEqual

LessThanOrEqual: FilterQueryOp = new FilterQueryOp({ operator: "le" })

Aliases: "le", "<="

Static NotEquals

NotEquals: FilterQueryOp = new FilterQueryOp({ operator: "ne" })

Aliases: "ne", "!="

Static StartsWith

StartsWith: FilterQueryOp = new FilterQueryOp({ operator: "startswith" })

No aliases

Methods

toJSON

  • toJSON(): object

toString

  • toString(): string

Static contains

  • Returns whether an Enum contains a specified symbol.

    let symbol = DayOfWeek.Friday;
    if (DayOfWeek.contains(symbol)) {
        // do something
    }

    Parameters

    Returns boolean

    Whether this Enum contains the specified symbol.

Static fromName

  • fromName(name: string): any
  • Returns an Enum symbol given its name.

    let dayOfWeek = DayOfWeek.from("Thursday");
    // nowdayOfWeek === DayOfWeek.Thursday

    Parameters

    • name: string

      Name for which an enum symbol should be returned.

    Returns any

    The symbol that matches the name or 'undefined' if not found.

Static getNames

  • getNames(): string[]
  • Returns the names of all of the symbols contained within this Enum.

    let symbols = DayOfWeek.getNames();

    Returns string[]

    All of the names of the symbols contained within this Enum.

Static getSymbols

  • Returns all of the symbols contained within this Enum.

    let symbols = DayOfWeek.getSymbols();

    Returns BreezeEnum[]

    All of the symbols contained within this Enum.

Static resolveSymbols

  • resolveSymbols(): object[]
  • Seals this enum so that no more symbols may be added to it. This should only be called after all symbols have already been added to the Enum. This method also sets the 'name' property on each of the symbols.

    DayOfWeek.resolveSymbols();

    Returns object[]

Generated using TypeDoc