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

instance.read(), array.read()

Reads the contents of a proxy object, or proxy object array into memory. Used to read reference properties.

Employees.first(employee =>
{
	// Now, we've loaded an Employee object, but it's reference properties
	// are not included. At this point, employee.supervisor is a proxy that can't be accessed.
	// If we want to convert it to a non-proxy, we need to read it:
	
	employee.supervisor.read(() =>
	{
		// employee.supervisor is now a non-proxy with all properies loaded.
	});
	
	employee.supervisedEmployees.read(() =>
	{
		// employee.supervisedEmployees array is now populated with Employee objects.
	});
});

Method signature (TypeScript)

read(completeFn?: (inst: Instance)): void;

Details

completeFn
An optional function to invoke after the object has been read into memory. The parameter passed to the function is a reference to the loaded object.
returns
void