Getting Started

Basics

Query Modifiers

.where() .sort()

Query Predicates

.equals() .notEquals() .exists() .notExists() .startsWith() .endsWith() .contains() .greaterThan() .lessThan() .between() .outside()

Query Executors

.read() .first() .last() .count() .sum() .average() .min() .max() .update() .delete()

Login Methods

.exists() .login() .logout()

Instance Methods

.read() .delete()

Instance Login Methods

.login() .logout() .changePassword()

Misc

Back.then() Back.saved() Back.user() Back.eachProperty() Back.eachDescendant() IFile Property LoginResult

ConstructorPlural.sort()

Sorts query results based on a Property parameter. May only be called once per query.

Employees
	.sort(Employee.salary)
	.read(employees =>
	{
		// employees is an array of Employee objects sorted by salary
	});

Method signature (TypeScript)

static sort(property: StringProperty, descending?: boolean);
static sort(property: NumberProperty, descending?: boolean);
static sort(property: EnumProperty, descending?: boolean);
static sort(property: DateProperty, descending?: boolean);

Details

property
A reference to the Property that the sort is applied against. The Property must be owned by the originating constructor, so Employee.sort(Employee.salary) is valid, but Employee.sort(Office.rent) is illogical and will generate an error. Not all properties are accepted (see the method signature).
descending
An optional boolean parameter that orders the result set in descending order. Default is false.
returns
An object containing all of the Query Modifiers and Query Executors, allowing you to continue applying .where() operations, or execute the query.