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

Property Class

Property objects are emitted as static members on your constructors, for each property you've defined in the editor. Property objects contain the meta data and helper methods for the associated property. All of the default members on the a property objects begin with an underscore (_). The primary use-case for the members of property objects is to provide a safe means of introspecting (meta-programming) into your backend.

Employee.salary._propertyName; // Stores the string "age"
Employee.salary._accepts(4); // Returns true
Employee.salary._accepts("four"); // Returns false, must be a number

Property object types

All derived property objects have all the same members, but their implementations (and type annotations in TypeScript) differ. The following types are available:

Class definition (TypeScript)

class Property
{
	_propertyName: string;
	_propertyType: {};
	_accepts(value: any): boolean;
	_default(value: any): boolean;
}

Members

_propertyName
A string containing the name of the property (example "age").
_propertyType
A reference to the property's constructor type irrespective of whether the property is an array. For example, StringProperty and NumberArrayProperty store the JavaScript built-in String and Number constructors. InstanceProperty and InstanceArrayProperty store a reference to your constructor, for example Employee.
_accepts
A method that returns whether the property accepts the specified value.
_default
A method that returns the default value for the property, as defined in the backend.