@loopback/docs
Version:
Documentation for LoopBack 4
2,446 lines (1,777 loc) • 867 kB
HTML
<!DOCTYPE html>
<!--[if lt IE 7]> <html class="no-js lt-ie9 lt-ie8 lt-ie7"> <![endif]-->
<!--[if IE 7]> <html class="no-js lt-ie9 lt-ie8"> <![endif]-->
<!--[if IE 8]> <html class="no-js lt-ie9"> <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js"> <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title></title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<link rel="stylesheet" href="css/bootstrap.min.css">
<link rel="stylesheet" href="css/code-themes/sl-theme.css">
<link rel="stylesheet" href="css/main.css">
</head>
<body>
<div class="navbar navbar-inverse navbar-static-top" role="navigation">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="/">docs.strongloop.com</a>
</div>
<div id="modules"></div>
</div>
<div class="row">
<div class="col-lg-3 column scroll-spy-target">
<ul class="nav nav-pills nav-stacked">
<div id="versions"></div>
<li class="depth-3">
<a href="#AnyObject">Interface: AnyObject</a>
</li>
<li class="depth-3">
<a href="#Class">Interface: Class</a>
</li>
<li class="depth-4">
<a href="#4">constructor()</a>
</li>
<li class="depth-3">
<a href="#ConstructorFunction">Interface: ConstructorFunction</a>
</li>
<li class="depth-3">
<a href="#Callback">Type: Callback</a>
</li>
<li class="depth-3">
<a href="#Command">Type: Command</a>
</li>
<li class="depth-3">
<a href="#Constructor">Type: Constructor</a>
</li>
<li class="depth-3">
<a href="#DataObject">Type: DataObject</a>
</li>
<li class="depth-3">
<a href="#NamedParameters">Type: NamedParameters</a>
</li>
<li class="depth-3">
<a href="#Options">Type: Options</a>
</li>
<li class="depth-3">
<a href="#PositionalParameters">Type: PositionalParameters</a>
</li>
<li class="depth-3">
<a href="#Connector">Interface: Connector</a>
</li>
<li class="depth-4">
<a href="#355">configModel</a>
</li>
<li class="depth-4">
<a href="#356">interfaces</a>
</li>
<li class="depth-4">
<a href="#354">name</a>
</li>
<li class="depth-4">
<a href="#357">connect()</a>
</li>
<li class="depth-4">
<a href="#359">disconnect()</a>
</li>
<li class="depth-4">
<a href="#363">execute()</a>
</li>
<li class="depth-4">
<a href="#361">ping()</a>
</li>
<li class="depth-3">
<a href="#CrudConnector">Interface: CrudConnector</a>
</li>
<li class="depth-4">
<a href="#571">count()</a>
</li>
<li class="depth-4">
<a href="#504">create()</a>
</li>
<li class="depth-4">
<a href="#509">createAll()</a>
</li>
<li class="depth-4">
<a href="#535">delete()</a>
</li>
<li class="depth-4">
<a href="#560">deleteAll()</a>
</li>
<li class="depth-4">
<a href="#565">deleteById()</a>
</li>
<li class="depth-4">
<a href="#576">exists()</a>
</li>
<li class="depth-4">
<a href="#519">find()</a>
</li>
<li class="depth-4">
<a href="#524">findById()</a>
</li>
<li class="depth-4">
<a href="#553">replaceById()</a>
</li>
<li class="depth-4">
<a href="#514">save()</a>
</li>
<li class="depth-4">
<a href="#530">update()</a>
</li>
<li class="depth-4">
<a href="#540">updateAll()</a>
</li>
<li class="depth-4">
<a href="#546">updateById()</a>
</li>
<li class="depth-3">
<a href="#KVConnector">Interface: KVConnector</a>
</li>
<li class="depth-4">
<a href="#599">delete()</a>
</li>
<li class="depth-4">
<a href="#604">deleteAll()</a>
</li>
<li class="depth-4">
<a href="#619">expire()</a>
</li>
<li class="depth-4">
<a href="#608">get()</a>
</li>
<li class="depth-4">
<a href="#635">iterateKeys()</a>
</li>
<li class="depth-4">
<a href="#631">keys()</a>
</li>
<li class="depth-4">
<a href="#613">set()</a>
</li>
<li class="depth-4">
<a href="#625">ttl()</a>
</li>
<li class="depth-3">
<a href="#DataSource">Interface: DataSource</a>
</li>
<li class="depth-4">
<a href="#767">connector</a>
</li>
<li class="depth-4">
<a href="#766">name</a>
</li>
<li class="depth-4">
<a href="#768">settings</a>
</li>
<li class="depth-3">
<a href="#ModelMetadataHelper">Class: ModelMetadataHelper</a>
</li>
<li class="depth-4">
<a href="#690">getModelMetadata()</a>
</li>
<li class="depth-3">
<a href="#property">Namespace: property</a>
</li>
<li class="depth-4">
<a href="#ERR_NO_ARGS">ERR_NO_ARGS</a>
</li>
<li class="depth-4">
<a href="#ERR_PROP_NOT_ARRAY">ERR_PROP_NOT_ARRAY</a>
</li>
<li class="depth-4">
<a href="#684">array()</a>
</li>
<li class="depth-3">
<a href="#PropertyMap">Type: PropertyMap</a>
</li>
<li class="depth-3">
<a href="#MODEL_KEY">MODEL_KEY</a>
</li>
<li class="depth-3">
<a href="#MODEL_PROPERTIES_KEY">MODEL_PROPERTIES_KEY</a>
</li>
<li class="depth-3">
<a href="#MODEL_WITH_PROPERTIES_KEY">MODEL_WITH_PROPERTIES_KEY</a>
</li>
<li class="depth-3">
<a href="#672">model()</a>
</li>
<li class="depth-3">
<a href="#RelationType">Enum: RelationType</a>
</li>
<li class="depth-4">
<a href="#696">belongsTo</a>
</li>
<li class="depth-4">
<a href="#700">embedsMany</a>
</li>
<li class="depth-4">
<a href="#699">embedsOne</a>
</li>
<li class="depth-4">
<a href="#698">hasMany</a>
</li>
<li class="depth-4">
<a href="#697">hasOne</a>
</li>
<li class="depth-4">
<a href="#702">referencesMany</a>
</li>
<li class="depth-4">
<a href="#701">referencesOne</a>
</li>
<li class="depth-3">
<a href="#RelationMetadata">Class: RelationMetadata</a>
</li>
<li class="depth-4">
<a href="#706">as</a>
</li>
<li class="depth-4">
<a href="#705">target</a>
</li>
<li class="depth-4">
<a href="#704">type</a>
</li>
<li class="depth-3">
<a href="#RELATIONS_KEY">RELATIONS_KEY</a>
</li>
<li class="depth-3">
<a href="#715">belongsTo()</a>
</li>
<li class="depth-3">
<a href="#743">embedsMany()</a>
</li>
<li class="depth-3">
<a href="#736">embedsOne()</a>
</li>
<li class="depth-3">
<a href="#729">hasMany()</a>
</li>
<li class="depth-3">
<a href="#722">hasOne()</a>
</li>
<li class="depth-3">
<a href="#757">referencesMany()</a>
</li>
<li class="depth-3">
<a href="#750">referencesOne()</a>
</li>
<li class="depth-3">
<a href="#708">relation()</a>
</li>
<li class="depth-3">
<a href="#RepositoryMetadata">Class: RepositoryMetadata</a>
</li>
<li class="depth-4">
<a href="#1690">constructor()</a>
</li>
<li class="depth-4">
<a href="#1689">dataSource</a>
</li>
<li class="depth-4">
<a href="#1688">dataSourceName</a>
</li>
<li class="depth-4">
<a href="#1687">modelClass</a>
</li>
<li class="depth-4">
<a href="#1686">modelName</a>
</li>
<li class="depth-4">
<a href="#1685">name</a>
</li>
<li class="depth-3">
<a href="#RepositoryDecorator">Type: RepositoryDecorator</a>
</li>
<li class="depth-3">
<a href="#1700">repository()</a>
</li>
<li class="depth-3">
<a href="#juggler">Namespace: juggler</a>
</li>
<li class="depth-4">
<a href="#Operators">Enum: Operators</a>
</li>
<li class="depth-4">
<a href="#DataSource">Class: DataSource</a>
</li>
<li class="depth-4">
<a href="#KeyValueModel">Class: KeyValueModel</a>
</li>
<li class="depth-4">
<a href="#ModelBase">Class: ModelBase</a>
</li>
<li class="depth-4">
<a href="#ModelBuilder">Class: ModelBuilder</a>
</li>
<li class="depth-4">
<a href="#ModelDefinition">Class: ModelDefinition</a>
</li>
<li class="depth-4">
<a href="#PersistedModel">Class: PersistedModel</a>
</li>
<li class="depth-4">
<a href="#ColumnMetadata">Interface: ColumnMetadata</a>
</li>
<li class="depth-4">
<a href="#Condition">Interface: Condition</a>
</li>
<li class="depth-4">
<a href="#Count">Interface: Count</a>
</li>
<li class="depth-4">
<a href="#Fields">Interface: Fields</a>
</li>
<li class="depth-4">
<a href="#Filter">Interface: Filter</a>
</li>
<li class="depth-4">
<a href="#IdDefinition">Interface: IdDefinition</a>
</li>
<li class="depth-4">
<a href="#Inclusion">Interface: Inclusion</a>
</li>
<li class="depth-4">
<a href="#IndexDefinition">Interface: IndexDefinition</a>
</li>
<li class="depth-4">
<a href="#PropertyDefinition">Interface: PropertyDefinition</a>
</li>
<li class="depth-4">
<a href="#RelationDefinition">Interface: RelationDefinition</a>
</li>
<li class="depth-4">
<a href="#Schema">Interface: Schema</a>
</li>
<li class="depth-4">
<a href="#Where">Interface: Where</a>
</li>
<li class="depth-4">
<a href="#KVData">Type: KVData</a>
</li>
<li class="depth-4">
<a href="#ModelData">Type: ModelData</a>
</li>
<li class="depth-4">
<a href="#PersistedData">Type: PersistedData</a>
</li>
<li class="depth-4">
<a href="#PromiseOrVoid">Type: PromiseOrVoid</a>
</li>
<li class="depth-3">
<a href="#MixinBuilder">Class: MixinBuilder</a>
</li>
<li class="depth-4">
<a href="#1716">constructor()</a>
</li>
<li class="depth-4">
<a href="#1717">baseClass</a>
</li>
<li class="depth-4">
<a href="#1720">with()</a>
</li>
<li class="depth-4">
<a href="#1723">mix()</a>
</li>
<li class="depth-3">
<a href="#MixinFunc">Interface: MixinFunc</a>
</li>
<li class="depth-3">
<a href="#AppWithRepository">Interface: AppWithRepository</a>
</li>
<li class="depth-4">
<a href="#1746">options</a>
</li>
<li class="depth-4">
<a href="#1739">component()</a>
</li>
<li class="depth-4">
<a href="#1735">dataSource()</a>
</li>
<li class="depth-4">
<a href="#1731">getRepository()</a>
</li>
<li class="depth-4">
<a href="#1742">mountComponentRepository()</a>
</li>
<li class="depth-4">
<a href="#1728">repository()</a>
</li>
<li class="depth-3">
<a href="#1838">RepositoryMixin()</a>
</li>
<li class="depth-3">
<a href="#Entity">Class: Entity</a>
</li>
<li class="depth-4">
<a href="#328">getId()</a>
</li>
<li class="depth-4">
<a href="#330">getIdObject()</a>
</li>
<li class="depth-4">
<a href="#332">buildWhereForId()</a>
</li>
<li class="depth-3">
<a href="#Event">Class: Event</a>
</li>
<li class="depth-4">
<a href="#348">source</a>
</li>
<li class="depth-4">
<a href="#349">type</a>
</li>
<li class="depth-3">
<a href="#Model">Class: Model</a>
</li>
<li class="depth-4">
<a href="#310">constructor()</a>
</li>
<li class="depth-4">
<a href="#302">definition</a>
</li>
<li class="depth-4">
<a href="#301">modelName</a>
</li>
<li class="depth-4">
<a href="#303">toJSON()</a>
</li>
<li class="depth-4">
<a href="#305">toObject()</a>
</li>
<li class="depth-3">
<a href="#ModelDefinition">Class: ModelDefinition</a>
</li>
<li class="depth-4">
<a href="#287">constructor()</a>
</li>
<li class="depth-4">
<a href="#276">name</a>
</li>
<li class="depth-4">
<a href="#277">properties</a>
</li>
<li class="depth-4">
<a href="#281">settings</a>
</li>
<li class="depth-4">
<a href="#290">addProperty()</a>
</li>
<li class="depth-4">
<a href="#294">addSetting()</a>
</li>
<li class="depth-4">
<a href="#298">idProperties()</a>
</li>
<li class="depth-3">
<a href="#ValueObject">Class: ValueObject</a>
</li>
<li class="depth-3">
<a href="#ModelDefinitionSyntax">Interface: ModelDefinitionSyntax</a>
</li>
<li class="depth-4">
<a href="#264">name</a>
</li>
<li class="depth-4">
<a href="#265">properties</a>
</li>
<li class="depth-4">
<a href="#269">settings</a>
</li>
<li class="depth-3">
<a href="#Persistable">Interface: Persistable</a>
</li>
<li class="depth-3">
<a href="#PropertyDefinition">Interface: PropertyDefinition</a>
</li>
<li class="depth-4">
<a href="#253">id</a>
</li>
<li class="depth-4">
<a href="#254">json</a>
</li>
<li class="depth-4">
<a href="#255">store</a>
</li>
<li class="depth-4">
<a href="#252">type</a>
</li>
<li class="depth-3">
<a href="#PropertyDefinitionMap">Interface: PropertyDefinitionMap</a>
</li>
<li class="depth-3">
<a href="#PropertyForm">Interface: PropertyForm</a>
</li>
<li class="depth-4">
<a href="#259">in</a>
</li>
<li class="depth-4">
<a href="#261">name</a>
</li>
<li class="depth-4">
<a href="#260">out</a>
</li>
<li class="depth-3">
<a href="#EntityData">Type: EntityData</a>
</li>
<li class="depth-3">
<a href="#PropertyType">Type: PropertyType</a>
</li>
<li class="depth-3">
<a href="#Operators">Enum: Operators</a>
</li>
<li class="depth-4">
<a href="#379">and</a>
</li>
<li class="depth-4">
<a href="#377">between</a>
</li>
<li class="depth-4">
<a href="#370">eq</a>
</li>
<li class="depth-4">
<a href="#378">exists</a>
</li>
<li class="depth-4">
<a href="#372">gt</a>
</li>
<li class="depth-4">
<a href="#373">gte</a>
</li>
<li class="depth-4">
<a href="#376">inq</a>
</li>
<li class="depth-4">
<a href="#374">lt</a>
</li>
<li class="depth-4">
<a href="#375">lte</a>
</li>
<li class="depth-4">
<a href="#371">neq</a>
</li>
<li class="depth-4">
<a href="#380">or</a>
</li>
<li class="depth-3">
<a href="#FilterBuilder">Class: FilterBuilder</a>
</li>
<li class="depth-4">
<a href="#467">constructor()</a>
</li>
<li class="depth-4">
<a href="#466">filter</a>
</li>
<li class="depth-4">
<a href="#491">build()</a>
</li>
<li class="depth-4">
<a href="#479">fields()</a>
</li>
<li class="depth-4">
<a href="#485">include()</a>
</li>
<li class="depth-4">
<a href="#470">limit()</a>
</li>
<li class="depth-4">
<a href="#473">offset()</a>
</li>
<li class="depth-4">
<a href="#482">order()</a>
</li>
<li class="depth-4">
<a href="#476">skip()</a>
</li>
<li class="depth-4">
<a href="#488">where()</a>
</li>
<li class="depth-3">
<a href="#WhereBuilder">Class: WhereBuilder</a>
</li>
<li class="depth-4">
<a href="#417">constructor()</a>
</li>
<li class="depth-4">
<a href="#416">where</a>
</li>
<li class="depth-4">
<a href="#420">and()</a>
</li>
<li class="depth-4">
<a href="#454">between()</a>
</li>
<li class="depth-4">
<a href="#463">build()</a>
</li>
<li class="depth-4">
<a href="#426">eq()</a>
</li>
<li class="depth-4">
<a href="#459">exists()</a>
</li>
<li class="depth-4">
<a href="#434">gt()</a>
</li>
<li class="depth-4">
<a href="#438">gte()</a>
</li>
<li class="depth-4">
<a href="#450">inq()</a>
</li>
<li class="depth-4">
<a href="#442">lt()</a>
</li>
<li class="depth-4">
<a href="#446">lte()</a>
</li>
<li class="depth-4">
<a href="#430">neq()</a>
</li>
<li class="depth-4">
<a href="#423">or()</a>
</li>
<li class="depth-3">
<a href="#Condition">Interface: Condition</a>
</li>
<li class="depth-4">
<a href="#391">and</a>
</li>
<li class="depth-4">
<a href="#389">between</a>
</li>
<li class="depth-4">
<a href="#382">eq</a>
</li>
<li class="depth-4">
<a href="#390">exists</a>
</li>
<li class="depth-4">
<a href="#384">gt</a>
</li>
<li class="depth-4">
<a href="#385">gte</a>
</li>
<li class="depth-4">
<a href="#388">inq</a>
</li>
<li class="depth-4">
<a href="#386">lt</a>
</li>
<li class="depth-4">
<a href="#387">lte</a>
</li>
<li class="depth-4">
<a href="#383">neq</a>
</li>
<li class="depth-4">
<a href="#392">or</a>
</li>
<li class="depth-3">
<a href="#Fields">Interface: Fields</a>
</li>
<li class="depth-3">
<a href="#Filter">Interface: Filter</a>
</li>
<li class="depth-4">
<a href="#409">fields</a>
</li>
<li class="depth-4">
<a href="#414">include</a>
</li>
<li class="depth-4">
<a href="#411">limit</a>
</li>
<li class="depth-4">
<a href="#413">offset</a>
</li>
<li class="depth-4">
<a href="#410">order</a>
</li>
<li class="depth-4">
<a href="#412">skip</a>
</li>
<li class="depth-4">
<a href="#408">where</a>
</li>
<li class="depth-3">
<a href="#Inclusion">Interface: Inclusion</a>
</li>
<li class="depth-4">
<a href="#405">relation</a>
</li>
<li class="depth-4">
<a href="#406">scope</a>
</li>
<li class="depth-3">
<a href="#Order">Interface: Order</a>
</li>
<li class="depth-3">
<a href="#Where">Interface: Where</a>
</li>
<li class="depth-4">
<a href="#394">and</a>
</li>
<li class="depth-4">
<a href="#395">or</a>
</li>
<li class="depth-3">
<a href="#Direction">Type: Direction</a>
</li>
<li class="depth-3">
<a href="#498">filterTemplate()</a>
</li>
<li class="depth-3">
<a href="#KVRepository">Interface: KVRepository</a>
</li>
<li class="depth-4">
<a href="#963">delete()</a>
</li>
<li class="depth-4">
<a href="#967">deleteAll()</a>
</li>
<li class="depth-4">
<a href="#979">expire()</a>
</li>
<li class="depth-4">
<a href="#970">get()</a>
</li>
<li class="depth-4">
<a href="#992">iterateKeys()</a>
</li>
<li class="depth-4">
<a href="#989">keys()</a>
</li>
<li class="depth-4">
<a href="#974">set()</a>
</li>
<li class="depth-4">
<a href="#984">ttl()</a>
</li>
<li class="depth-3">
<a href="#DefaultCrudRepository">Class: DefaultCrudRepository</a>
</li>
<li class="depth-4">
<a href="#1591">constructor()</a>
</li>
<li class="depth-4">
<a href="#1595">dataSource</a>
</li>
<li class="depth-4">
<a href="#1592">entityClass</a>
</li>
<li class="depth-4">
<a href="#1590">modelClass</a>
</li>
<li class="depth-4">
<a href="#1657">count()</a>
</li>
<li class="depth-4">
<a href="#1601">create()</a>
</li>
<li class="depth-4">
<a href="#1605">createAll()</a>
</li>
<li class="depth-4">
<a href="#1630">delete()</a>
</li>
<li class="depth-4">
<a href="#1649">deleteAll()</a>
</li>
<li class="depth-4">
<a href="#1653">deleteById()</a>
</li>
<li class="depth-4">
<a href="#1665">execute()</a>
</li>
<li class="depth-4">
<a href="#1661">exists()</a>
</li>
<li class="depth-4">
<a href="#1613">find()</a>
</li>
<li class="depth-4">
<a href="#1621">findById()</a>
</li>
<li class="depth-4">
<a href="#1617">findOne()</a>
</li>
<li class="depth-4">
<a href="#1644">replaceById()</a>
</li>
<li class="depth-4">
<a href="#1609">save()</a>
</li>
<li class="depth-4">
<a href="#1626">update()</a>
</li>
<li class="depth-4">
<a href="#1634">updateAll()</a>
</li>
<li class="depth-4">
<a href="#1639">updateById()</a>
</li>
<li class="depth-3">
<a href="#DataSourceConstructor">DataSourceConstructor</a>
</li>
<li class="depth-3">
<a href="#ModelBaseConstructor">ModelBaseConstructor</a>
</li>
<li class="depth-3">
<a href="#jugglerModule">jugglerModule</a>
</li>
<li class="depth-3">
<a href="#1674">bindModel()</a>
</li>
<li class="depth-3">
<a href="#CrudRepositoryImpl">Class: CrudRepositoryImpl</a>
</li>
<li class="depth-4">
<a href="#890">constructor()</a>
</li>
<li class="depth-4">
<a href="#891">dataSource</a>
</li>
<li class="depth-4">
<a href="#892">model</a>
</li>
<li class="depth-4">
<a href="#947">count()</a>
</li>
<li class="depth-4">
<a href="#896">create()</a>
</li>
<li class="depth-4">
<a href="#900">createAll()</a>
</li>
<li class="depth-4">
<a href="#920">delete()</a>
</li>
<li class="depth-4">
<a href="#939">deleteAll()</a>
</li>
<li class="depth-4">
<a href="#943">deleteById()</a>
</li>
<li class="depth-4">
<a href="#955">execute()</a>
</li>
<li class="depth-4">
<a href="#951">exists()</a>
</li>
<li class="depth-4">
<a href="#908">find()</a>
</li>
<li class="depth-4">
<a href="#912">findById()</a>
</li>
<li class="depth-4">
<a href="#934">replaceById()</a>
</li>
<li class="depth-4">
<a href="#904">save()</a>
</li>
<li class="depth-4">
<a href="#916">update()</a>
</li>
<li class="depth-4">
<a href="#924">updateAll()</a>
</li>
<li class="depth-4">
<a href="#929">updateById()</a>
</li>
<li class="depth-3">
<a href="#CrudRepository">Interface: CrudRepository</a>
</li>
<li class="depth-4">
<a href="#802">count()</a>
</li>
<li class="depth-4">
<a href="#781">create()</a>
</li>
<li class="depth-4">
<a href="#785">createAll()</a>
</li>
<li class="depth-4">
<a href="#798">deleteAll()</a>
</li>
<li class="depth-4">
<a href="#789">find()</a>
</li>
<li class="depth-4">
<a href="#793">updateAll()</a>
</li>
<li class="depth-3">
<a href="#EntityCrudRepository">Interface: EntityCrudRepository</a>
</li>
<li class="depth-4">
<a href="#830">delete()</a>
</li>
<li class="depth-4">
<a href="#849">deleteById()</a>
</li>
<li class="depth-4">
<a href="#853">exists()</a>
</li>
<li class="depth-4">
<a href="#834">findById()</a>
</li>
<li class="depth-4">
<a href="#844">replaceById()</a>
</li>
<li class="depth-4">
<a href="#822">save()</a>
</li>
<li class="depth-4">
<a href="#826">update()</a>
</li>
<li class="depth-4">
<a href="#839">updateById()</a>
</li>
<li class="depth-3">
<a href="#EntityRepository">Interface: EntityRepository</a>
</li>
<li class="depth-3">
<a href="#Repository">Interface: Repository</a>
</li>
<li class="depth-4">
<a href="#774">execute()</a>
</li>
<li class="depth-3">
<a href="#AnyType">Class: AnyType</a>
</li>
<li class="depth-4">
<a href="#140">name</a>
</li>
<li class="depth-4">
<a href="#149">coerce()</a>
</li>
<li class="depth-4">
<a href="#147">defaultValue()</a>
</li>
<li class="depth-4">
<a href="#144">isCoercible()</a>
</li>
<li class="depth-4">
<a href="#141">isInstance()</a>
</li>
<li class="depth-4">
<a href="#152">serialize()</a>
</li>
<li class="depth-3">
<a href="#ArrayType">Class: ArrayType</a>
</li>
<li class="depth-4">
<a href="#158">constructor()</a>
</li>
<li class="depth-4">
<a href="#159">itemType</a>
</li>
<li class="depth-4">
<a href="#162">name</a>
</li>
<li class="depth-4">
<a href="#171">coerce()</a>
</li>
<li class="depth-4">
<a href="#169">defaultValue()</a>
</li>
<li class="depth-4">
<a href="#166">isCoercible()</a>
</li>
<li class="depth-4">
<a href="#163">isInstance()</a>
</li>
<li class="depth-4">
<a href="#174">serialize()</a>
</li>
<li class="depth-3">
<a href="#BooleanType">Class: BooleanType</a>
</li>
<li class="depth-4">
<a href="#70">name</a>
</li>
<li class="depth-4">
<a href="#79">coerce()</a>
</li>
<li class="depth-4">
<a href="#74">defaultValue()</a>
</li>
<li class="depth-4">
<a href="#76">isCoercible()</a>
</li>
<li class="depth-4">
<a href="#71">isInstance()</a>
</li>
<li class="depth-4">
<a href="#82">serialize()</a>
</li>
<li class="depth-3">
<a href="#BufferType">Class: BufferType</a>
</li>
<li class="depth-4">
<a href="#121">name</a>
</li>
<li class="depth-4">
<a href="#130">coerce()</a>
</li>
<li class="depth-4">
<a href="#125">defaultValue()</a>
</li>
<li class="depth-4">
<a href="#127">isCoercible()</a>
</li>
<li class="depth-4">
<a href="#122">isInstance()</a>
</li>
<li class="depth-4">
<a href="#134">serialize()</a>
</li>
<li class="depth-3">
<a href="#DateType">Class: DateType</a>
</li>
<li class="depth-4">
<a href="#104">name</a>
</li>
<li class="depth-4">
<a href="#113">coerce()</a>
</li>
<li class="depth-4">
<a href="#111">defaultValue()</a>
</li>
<li class="depth-4">
<a href="#108">isCoercible()</a>
</li>
<li class="depth-4">
<a href="#105">isInstance()</a>
</li>
<li class="depth-4">
<a href="#116">serialize()</a>
</li>
<li class="depth-3">
<a href="#ANY">ANY</a>
</li>
<li class="depth-3">
<a href="#BOOLEAN">BOOLEAN</a>
</li>
<li class="depth-3">
<a href="#BUFFER">BUFFER</a>
</li>
<li class="depth-3">
<a href="#DATE">DATE</a>
</li>
<li class="depth-3">
<a href="#NUMBER">NUMBER</a>
</li>
<li class="depth-3">
<a href="#STRING">STRING</a>
</li>
<li class="depth-3">
<a href="#ModelType">Class: ModelType</a>
</li>
<li class="depth-4">
<a href="#224">constructor()</a>
</li>
<li class="depth-4">
<a href="#225">modelClass</a>
</li>
<li class="depth-4">
<a href="#223">name</a>
</li>
<li class="depth-4">
<a href="#228">serialize()</a>
</li>
<li class="depth-3">
<a href="#NumberType">Class: NumberType</a>
</li>
<li class="depth-4">
<a href="#87">name</a>
</li>
<li class="depth-4">
<a href="#96">coerce()</a>
</li>
<li class="depth-4">
<a href="#94">defaultValue()</a>
</li>
<li class="depth-4">
<a href="#91">isCoercible()</a>
</li>
<li class="depth-4">
<a href="#88">isInstance()</a>
</li>
<li class="depth-4">
<a href="#99">serialize()</a>
</li>
<li class="depth-3">
<a href="#ObjectType">Class: ObjectType</a>
</li>
<li class="depth-4">
<a href="#202">constructor()</a>
</li>
<li class="depth-4">
<a href="#201">name</a>
</li>
<li class="depth-4">
<a href="#203">type</a>
</li>
<li class="depth-4">
<a href="#214">coerce()</a>
</li>
<li class="depth-4">
<a href="#212">defaultValue()</a>
</li>
<li class="depth-4">
<a href="#209">isCoercible()</a>
</li>
<li class="depth-4">
<a href="#206">isInstance()</a>
</li>
<li class="depth-4">
<a href="#217">serialize()</a>
</li>
<li class="depth-3">
<a href="#StringType">Class: StringType</a>
</li>
<li class="depth-4">
<a href="#53">name</a>
</li>
<li class="depth-4">
<a href="#62">coerce()</a>
</li>
<li class="depth-4">
<a href="#60">defaultValue()</a>
</li>
<li class="depth-4">
<a href="#57">isCoercible()</a>
</li>
<li class="depth-4">
<a href="#54">isInstance()</a>
</li>
<li class="depth-4">
<a href="#65">serialize()</a>
</li>
<li class="depth-3">
<a href="#Type">Interface: Type</a>
</li>
<li class="depth-4">
<a href="#33">name</a>
</li>
<li class="depth-4">
<a href="#43">coerce()</a>
</li>
<li class="depth-4">
<a href="#37">defaultValue()</a>
</li>
<li class="depth-4">
<a href="#39">isCoercible()</a>
</li>
<li class="depth-4">
<a href="#34">isInstance()</a>
</li>
<li class="depth-4">
<a href="#47">serialize()</a>
</li>
<li class="depth-3">
<a href="#UnionType">Class: UnionType</a>
</li>
<li class="depth-4">
<a href="#179">constructor()</a>
</li>
<li class="depth-4">
<a href="#180">itemTypes</a>
</li>
<li class="depth-4">
<a href="#183">name</a>
</li>
<li class="depth-4">
<a href="#192">coerce()</a>
</li>
<li class="depth-4">
<a href="#190">defaultValue()</a>
</li>
<li class="depth-4">
<a href="#187">isCoercible()</a>
</li>
<li class="depth-4">
<a href="#184">isInstance()</a>
</li>
<li class="depth-4">
<a href="#195">serialize()</a>
</li>
</ul>
</div>
<div class="col-lg-9 col-lg-offset-3 column" data-spy="scroll" data-target=".scroll-spy-target" data-offset="0">
<div class="readability">
<section class="code-doc ">
<a name="AnyObject"></a>
<h3 class="code-ref">Interface: AnyObject</h3>
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Objects with open properties</p>
</p>
<p></p>
</div>
</section>
<section class="code-doc ">
<a name="Class"></a>
<h3 class="code-ref">Interface: Class</h3>
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Interface for classes with <code>new</code> operator and static properties/methods</p>
</p>
<p></p>
</div>
</section>
<section class="code-doc ">
<a name="4"></a>
<h4 class="code-ref">constructor(args: any[]) : T</h4>
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<!-- A table of members such as parameters/properties/variables -->
<div class="code-arguments-hdr">Parameters</div>
<table class="params code-arguments">
<tr>
<th class="hdr-name">Name</th>
<th class="hdr-type">Type</th>
<th class="hdr-default-value">Default Value</th>
<th class="hdr-flags">Flags</th>
<th class="hdr-desc">Description</th>
</tr>
<tr class="code-arg">
<td>
<a name=""></a>
<strong class="code-arg-name">
args
</strong>
</td>
<td class="code-arg-types">
<code>any[]</code>
</td>
<td class="code-arg-default-value">
</td>
<td class="code-arg-flags">
rest
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Interface for classes with <code>new</code> operator and static properties/methods</p>
</p>
<p></p>
</div>
</td>
</tr>
</table>
</section>
<section class="code-doc ">
<a name="ConstructorFunction"></a>
<h3 class="code-ref">Interface: ConstructorFunction</h3>
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Interface for constructor functions without <code>new</code> operator, for example,</p>
<pre><code><span class="hljs-function"><span class="hljs-keyword">function</span> <span class="hljs-title">Foo</span><span class="hljs-params">(x)</span> </span>{
<span class="hljs-keyword">if</span> (!(<span class="hljs-keyword">this</span> <span class="hljs-keyword">instanceof</span> Foo)) { <span class="hljs-keyword">return</span> <span class="hljs-keyword">new</span> Foo(x); }
<span class="hljs-keyword">this</span>.x = x;
}
</code></pre></p>
<p></p>
</div>
</section>
<section class="code-doc ">
<a name="Callback"></a>
<h3 class="code-ref">Type alias: Callback(err: <a href="#Error">Error</a> | string | null | undefined, result: <a href="#T">T</a>): void</h3>
<div class="code-desc">
<p><p>Type alias for Node.js callback functions</p>
</p>
<p></p>
</div>
<div class="code-arguments-hdr">Arguments</div>
<table class="params code-arguments">
<tr>
<th class="hdr-name">Name</th>
<th class="hdr-type">Type</th>
<th class="hdr-desc">Description</th>
</tr>
<tr class="code-arg">
<td>
<strong class="code-arg-name">err</strong>
</td>
<td class="code-arg-types">
<code><a href="#Error">Error</a> | string | null | undefined</code>
</td>
<td class="code-arg-desc">
</td>
</tr>
<tr class="code-arg">
<td>
<strong class="code-arg-name">result</strong>
</td>
<td class="code-arg-types">
<code><a href="#T">T</a></code>
</td>
<td class="code-arg-desc">
</td>
</tr>
</table>
</section>
<section class="code-doc ">
<a name="NamedParameters"></a>
<h3 class="code-ref">Type alias: NamedParameters = AnyObject</h3>
</section>
<section class="code-doc ">
<a name="PositionalParameters"></a>
<h3 class="code-ref">Type alias: PositionalParameters = any[]</h3>
</section>
<section class="code-doc ">
<a name="Connector"></a>
<h3 class="code-ref">Interface: Connector</h3>
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Common properties/operations for connectors</p>
</p>
<p></p>
</div>
</section>
<section class="code-doc">
<!-- A table of members such as parameters/properties/variables -->
<div class="code-arguments-hdr">Properties</div>
<table class="params code-arguments">
<tr>
<th class="hdr-name">Name</th>
<th class="hdr-type">Type</th>
<th class="hdr-default-value">Default Value</th>
<th class="hdr-flags">Flags</th>
<th class="hdr-desc">Description</th>
</tr>
<tr class="code-arg">
<td>
<a name="355"></a>
<strong class="code-arg-name">
configModel
</strong>
</td>
<td class="code-arg-types">
<code><a href="#Model">Model</a></code>
</td>
<td class="code-arg-default-value">
</td>
<td class="code-arg-flags">
exported optional
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Common properties/operations for connectors</p>
</p>
<p></p>
</div>
</td>
</tr>
<tr class="code-arg">
<td>
<a name="356"></a>
<strong class="code-arg-name">
interfaces
</strong>
</td>
<td class="code-arg-types">
<code>string[]</code>
</td>
<td class="code-arg-default-value">
</td>
<td class="code-arg-flags">
exported optional
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Common properties/operations for connectors</p>
</p>
<p></p>
</div>
</td>
</tr>
<tr class="code-arg">
<td>
<a name="354"></a>
<strong class="code-arg-name">
name
</strong>
</td>
<td class="code-arg-types">
<code>string</code>
</td>
<td class="code-arg-default-value">
</td>
<td class="code-arg-flags">
exported
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Common properties/operations for connectors</p>
</p>
<p></p>
</div>
</td>
</tr>
</table>
</section>
<section class="code-doc ">
<a name="357"></a>
<h4 class="code-ref">connect() : <a href="#Promise">Promise</a><void></h4>
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
</section>
<section class="code-doc ">
<a name="359"></a>
<h4 class="code-ref">disconnect() : <a href="#Promise">Promise</a><void></h4>
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
</section>
<section class="code-doc ">
<a name="363"></a>
<h4 class="code-ref">execute(command: <a href="#Command">Command</a>, parameters: <a href="#NamedParameters">NamedParameters</a> | <a href="#PositionalParameters">PositionalParameters</a>, options: <a href="#Options">Options</a>) : <a href="#Promise">Promise</a><<a href="#AnyObject">AnyObject</a>></h4>
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<!-- A table of members such as parameters/properties/variables -->
<div class="code-arguments-hdr">Parameters</div>
<table class="params code-arguments">
<tr>
<th class="hdr-name">Name</th>
<th class="hdr-type">Type</th>
<th class="hdr-default-value">Default Value</th>
<th class="hdr-flags">Flags</th>
<th class="hdr-desc">Description</th>
</tr>
<tr class="code-arg">
<td>
<a name=""></a>
<strong class="code-arg-name">
command
</strong>
</td>
<td class="code-arg-types">
<code><a href="#Command">Command</a></code>
</td>
<td class="code-arg-default-value">
</td>
<td class="code-arg-flags">
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Common properties/operations for connectors</p>
</p>
<p></p>
</div>
</td>
</tr>
<tr class="code-arg">
<td>
<a name=""></a>
<strong class="code-arg-name">
parameters
</strong>
</td>
<td class="code-arg-types">
<code><a href="#NamedParameters">NamedParameters</a> | <a href="#PositionalParameters">PositionalParameters</a></code>
</td>
<td class="code-arg-default-value">
</td>
<td class="code-arg-flags">
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Common properties/operations for connectors</p>
</p>
<p></p>
</div>
</td>
</tr>
<tr class="code-arg">
<td>
<a name=""></a>
<strong class="code-arg-name">
options
</strong>
</td>
<td class="code-arg-types">
<code><a href="#Options">Options</a></code>
</td>
<td class="code-arg-default-value">
</td>
<td class="code-arg-flags">
optional
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Common properties/operations for connectors</p>
</p>
<p></p>
</div>
</td>
</tr>
</table>
</section>
<section class="code-doc ">
<a name="361"></a>
<h4 class="code-ref">ping() : <a href="#Promise">Promise</a><void></h4>
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
</section>
<section class="code-doc ">
<a name="CrudConnector"></a>
<h3 class="code-ref">Interface: CrudConnector</h3>
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>CRUD operations for connector implementations</p>
</p>
<p></p>
</div>
</section>
<section class="code-doc ">
<a name="571"></a>
<h4 class="code-ref">count(modelClass: <a href="#Class">Class</a><<a href="#Entity">Entity</a>>, where: <a href="#Where">Where</a>, options: <a href="#Options">Options</a>) : <a href="#Promise">Promise</a><number></h4>
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Count matching entities</p>
</p>
<p></p>
</div>
Returns: <p><p>A promise of number of matching entities</p>
</p>
<!-- A table of members such as parameters/properties/variables -->
<div class="code-arguments-hdr">Parameters</div>
<table class="params code-arguments">
<tr>
<th class="hdr-name">Name</th>
<th class="hdr-type">Type</th>
<th class="hdr-default-value">Default Value</th>
<th class="hdr-flags">Flags</th>
<th class="hdr-desc">Description</th>
</tr>
<tr class="code-arg">
<td>
<a name=""></a>
<strong class="code-arg-name">
modelClass
</strong>
</td>
<td class="code-arg-types">
<code><a href="#Class">Class</a><<a href="#Entity">Entity</a>></code>
</td>
<td class="code-arg-default-value">
</td>
<td class="code-arg-flags">
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p></p>
<p><p>The model class</p>
</p>
</div>
</td>
</tr>
<tr class="code-arg">
<td>
<a name=""></a>
<strong class="code-arg-name">
where
</strong>
</td>
<td class="code-arg-types">
<code><a href="#Where">Where</a></code>
</td>
<td class="code-arg-default-value">
</td>
<td class="code-arg-flags">
optional
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p></p>
<p><p>The matching criteria</p>
</p>
</div>
</td>
</tr>
<tr class="code-arg">
<td>
<a name=""></a>
<strong class="code-arg-name">
options
</strong>
</td>
<td class="code-arg-types">
<code><a href="#Options">Options</a></code>
</td>
<td class="code-arg-default-value">
</td>
<td class="code-arg-flags">
optional
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p></p>
<p><p>Options for the operation</p>
</p>
</div>
</td>
</tr>
</table>
</section>
<section class="code-doc ">
<a name="504"></a>
<h4 class="code-ref">create(modelClass: <a href="#Class">Class</a><<a href="#Entity">Entity</a>>, entity: <a href="#EntityData">EntityData</a>, options: <a href="#Options">Options</a>) : <a href="#Promise">Promise</a><<a href="#EntityData">EntityData</a>></h4>
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Create a new entity</p>
</p>
<p></p>
</div>
Returns: <p><p>A promise of the entity created</p>
</p>
<!-- A table of members such as parameters/properties/variables -->
<div class="code-arguments-hdr">Parameters</div>
<table class="params code-arguments">
<tr>
<th class="hdr-name">Name</th>
<th class="hdr-type">Type</th>
<th class="hdr-default-value">Default Value</th>
<th class="hdr-flags">Flags</th>
<th class="hdr-desc">Description</th>
</tr>
<tr class="code-arg">
<td>
<a name=""></a>
<strong class="code-arg-name">
modelClass
</strong>
</td>
<td class="code-arg-types">
<code><a href="#Class">Class</a><<a href="#Entity">Entity</a>></code>
</td>
<td class="code-arg-default-value">
</td>
<td class="code-arg-flags">
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p></p>
<p><p>The model class</p>
</p>
</div>
</td>
</tr>
<tr class="code-arg">
<td>
<a name=""></a>
<strong class="code-arg-name">
entity
</strong>
</td>
<td class="code-arg-types">
<code><a href="#EntityData">EntityData</a></code>
</td>
<td class="code-arg-default-va