breeze-client / FilterQueryOp

Class: FilterQueryOp

Defined in: src/query/entity-query.ts:1181

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

Extends

• BreezeEnum

Implements

• QueryOp

Constructors

Constructor

new FilterQueryOp(propertiesObj?): FilterQueryOp

Defined in: src/core/enum.ts:72

Creates a symbol, copying each property of propertiesObj onto it. Used to declare the symbols of an enum, as static members of its class; its name is set when the class calls BreezeEnum.resolveSymbols.

Parameters

propertiesObj?

Object

Returns

FilterQueryOp

Inherited from

BreezeEnum.constructor

Properties

_$typeName

_$typeName: string

Defined in: src/core/enum.ts:60

Type of the enum; set in prototype of each enum

Inherited from

BreezeEnum._$typeName

---

name

name: string

Defined in: src/core/enum.ts:58

The name of this symbol

Inherited from

BreezeEnum.name

---

operator

operator: string

Defined in: src/query/entity-query.ts:1183

The operator for this enum.

Implementation of

QueryOp.operator

---

All

static All: FilterQueryOp

Defined in: src/query/entity-query.ts:1206

Aliases: "every"

---

Any

static Any: FilterQueryOp

Defined in: src/query/entity-query.ts:1204

Aliases: "some"

---

Contains

static Contains: FilterQueryOp

Defined in: src/query/entity-query.ts:1198

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

---

EndsWith

static EndsWith: FilterQueryOp

Defined in: src/query/entity-query.ts:1202

No aliases

---

Equals

static Equals: FilterQueryOp

Defined in: src/query/entity-query.ts:1186

Aliases: "eq", "=="

---

GreaterThan

static GreaterThan: FilterQueryOp

Defined in: src/query/entity-query.ts:1190

Aliases: "gt", ">"

---

GreaterThanOrEqual

static GreaterThanOrEqual: FilterQueryOp

Defined in: src/query/entity-query.ts:1194

Aliases: "ge", ">="

---

In

static In: FilterQueryOp

Defined in: src/query/entity-query.ts:1208

No aliases

---

LessThan

static LessThan: FilterQueryOp

Defined in: src/query/entity-query.ts:1192

Aliases: "lt", "<"

---

LessThanOrEqual

static LessThanOrEqual: FilterQueryOp

Defined in: src/query/entity-query.ts:1196

Aliases: "le", "<="

---

NotEquals

static NotEquals: FilterQueryOp

Defined in: src/query/entity-query.ts:1188

Aliases: "ne", "!="

---

StartsWith

static StartsWith: FilterQueryOp

Defined in: src/query/entity-query.ts:1200

No aliases

Methods

toJSON()

toJSON(): object

Defined in: src/core/enum.ts:180

Return enum name and symbol name

Returns

_$typeName

_$typeName: any

The name of the enum, such as "EntityState".

name

name: string

The name of the symbol, such as "Added".

Inherited from

BreezeEnum.toJSON

---

toString()

toString(): string

Defined in: src/core/enum.ts:175

Returns the string name of this Enum

Returns

string

Inherited from

BreezeEnum.toString

---

contains()

static contains(sym): boolean

Defined in: src/core/enum.ts:154

Returns whether an Enum contains a specified symbol.

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

Parameters

sym

BreezeEnum

Object or symbol to test.

Returns

boolean

Whether this Enum contains the specified symbol.

Inherited from

BreezeEnum.contains

---

fromName()

static fromName(name): any

Defined in: src/core/enum.ts:113

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.

Inherited from

BreezeEnum.fromName

---

getNames()

static getNames(): string[]

Defined in: src/core/enum.ts:100

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.

Inherited from

BreezeEnum.getNames

---

getSymbols()

static getSymbols<T>(this): InstanceType<T>[]

Defined in: src/core/enum.ts:86

Returns all of the symbols contained within this Enum.

let symbols = DayOfWeek.getSymbols();

Type Parameters

T

T extends typeof BreezeEnum

Parameters

this

T

Returns

InstanceType<T>[]

All of the symbols contained within this Enum.

Inherited from

BreezeEnum.getSymbols

---

resolveSymbols()

static resolveSymbols(): object[]

Defined in: src/core/enum.ts:124

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

Inherited from

BreezeEnum.resolveSymbols