@loopback/docs

<!DOCTYPE html>     <html class="no-js">  <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 alias: Callback</a> </li> <li class="depth-3"> <a href="#Command">Type alias: Command</a> </li> <li class="depth-3"> <a href="#Constructor">Type alias: Constructor</a> </li> <li class="depth-3"> <a href="#DataObject">Type alias: DataObject</a> </li> <li class="depth-3"> <a href="#NamedParameters">Type alias: NamedParameters</a> </li> <li class="depth-3"> <a href="#Options">Type alias: Options</a> </li> <li class="depth-3"> <a href="#PositionalParameters">Type alias: PositionalParameters</a> </li> <li class="depth-3"> <a href="#Connector">Interface: Connector</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-3"> <a href="#ModelMetadataHelper">Class: ModelMetadataHelper</a> </li> <li class="depth-4"> <a href="#677">getModelMetadata</a> </li> <li class="depth-3"> <a href="#671">Function: property.array</a> </li> <li class="depth-3"> <a href="#PropertyMap">Type alias: PropertyMap</a> </li> <li class="depth-3"> <a href="#659">Function: model</a> </li> <li class="depth-3"> <a href="#RelationMetadata">Class: RelationMetadata</a> </li> <li class="depth-3"> <a href="#702">Function: belongsTo</a> </li> <li class="depth-3"> <a href="#730">Function: embedsMany</a> </li> <li class="depth-3"> <a href="#723">Function: embedsOne</a> </li> <li class="depth-3"> <a href="#716">Function: hasMany</a> </li> <li class="depth-3"> <a href="#709">Function: hasOne</a> </li> <li class="depth-3"> <a href="#744">Function: referencesMany</a> </li> <li class="depth-3"> <a href="#737">Function: referencesOne</a> </li> <li class="depth-3"> <a href="#695">Function: relation</a> </li> <li class="depth-3"> <a href="#RepositoryMetadata">Class: RepositoryMetadata</a> </li> <li class="depth-4"> <a href="#1677">constructor</a> </li> <li class="depth-3"> <a href="#RepositoryDecorator">Type alias: RepositoryDecorator</a> </li> <li class="depth-3"> <a href="#1687">Function: repository</a> </li> <li class="depth-3"> <a href="#juggler.DataSource">Class: juggler.DataSource</a> </li> <li class="depth-4"> <a href="#1279">constructor</a> </li> <li class="depth-4"> <a href="#1287">createModel</a> </li> <li class="depth-3"> <a href="#juggler.KeyValueModel">Class: juggler.KeyValueModel</a> </li> <li class="depth-4"> <a href="#1531">expire</a> </li> <li class="depth-4"> <a href="#1520">get</a> </li> <li class="depth-4"> <a href="#1547">iterateKeys</a> </li> <li class="depth-4"> <a href="#1542">keys</a> </li> <li class="depth-4"> <a href="#1525">set</a> </li> <li class="depth-4"> <a href="#1537">ttl</a> </li> <li class="depth-3"> <a href="#juggler.ModelBase">Class: juggler.ModelBase</a> </li> <li class="depth-4"> <a href="#1142">constructor</a> </li> <li class="depth-4"> <a href="#1145">toJSON</a> </li> <li class="depth-4"> <a href="#1147">toObject</a> </li> <li class="depth-4"> <a href="#1139">attachTo</a> </li> <li class="depth-3"> <a href="#juggler.ModelBuilder">Class: juggler.ModelBuilder</a> </li> <li class="depth-4"> <a href="#1202">buildModelFromInstance</a> </li> <li class="depth-4"> <a href="#1195">buildModels</a> </li> <li class="depth-4"> <a href="#1170">define</a> </li> <li class="depth-4"> <a href="#1176">defineProperty</a> </li> <li class="depth-4"> <a href="#1181">defineValueType</a> </li> <li class="depth-4"> <a href="#1185">extendModel</a> </li> <li class="depth-4"> <a href="#1163">getModel</a> </li> <li class="depth-4"> <a href="#1167">getModelDefinition</a> </li> <li class="depth-4"> <a href="#1189">getSchemaName</a> </li> <li class="depth-4"> <a href="#1192">resolveType</a> </li> <li class="depth-3"> <a href="#juggler.ModelDefinition">Class: juggler.ModelDefinition</a> </li> <li class="depth-4"> <a href="#1021">constructor</a> </li> <li class="depth-4"> <a href="#1062">build</a> </li> <li class="depth-4"> <a href="#1043">columnMetadata</a> </li> <li class="depth-4"> <a href="#1036">columnName</a> </li> <li class="depth-4"> <a href="#1040">columnNames</a> </li> <li class="depth-4"> <a href="#1053">defineProperty</a> </li> <li class="depth-4"> <a href="#1049">idName</a> </li> <li class="depth-4"> <a href="#1051">idNames</a> </li> <li class="depth-4"> <a href="#1047">ids</a> </li> <li class="depth-4"> <a href="#1057">indexes</a> </li> <li class="depth-4"> <a href="#1033">tableName</a> </li> <li class="depth-4"> <a href="#1065">toJSON</a> </li> <li class="depth-3"> <a href="#juggler.PersistedModel">Class: juggler.PersistedModel</a> </li> <li class="depth-4"> <a href="#1470">delete</a> </li> <li class="depth-4"> <a href="#1462">destroy</a> </li> <li class="depth-4"> <a href="#1497">getId</a> </li> <li class="depth-4"> <a href="#1499">getIdName</a> </li> <li class="depth-4"> <a href="#1460">isNewRecord</a> </li> <li class="depth-4"> <a href="#1490">reload</a> </li> <li class="depth-4"> <a href="#1466">remove</a> </li> <li class="depth-4"> <a href="#1485">replaceAttributes</a> </li> <li class="depth-4"> <a href="#1456">save</a> </li> <li class="depth-4"> <a href="#1494">setId</a> </li> <li class="depth-4"> <a href="#1474">updateAttribute</a> </li> <li class="depth-4"> <a href="#1480">updateAttributes</a> </li> <li class="depth-4"> <a href="#1451">count</a> </li> <li class="depth-4"> <a href="#1339">create</a> </li> <li class="depth-4"> <a href="#1413">deleteAll</a> </li> <li class="depth-4"> <a href="#1440">deleteById</a> </li> <li class="depth-4"> <a href="#1403">destroyAll</a> </li> <li class="depth-4"> <a href="#1430">destroyById</a> </li> <li class="depth-4"> <a href="#1382">exists</a> </li> <li class="depth-4"> <a href="#1393">find</a> </li> <li class="depth-4"> <a href="#1387">findById</a> </li> <li class="depth-4"> <a href="#1398">findOne</a> </li> <li class="depth-4"> <a href="#1376">findOrCreate</a> </li> <li class="depth-4"> <a href="#1501">getIdName</a> </li> <li class="depth-4"> <a href="#1354">patchOrCreate</a> </li> <li class="depth-4"> <a href="#1365">patchOrCreateWithWhere</a> </li> <li class="depth-4"> <a href="#1408">remove</a> </li> <li class="depth-4"> <a href="#1435">removeById</a> </li> <li class="depth-4"> <a href="#1445">replaceById</a> </li> <li class="depth-4"> <a href="#1371">replaceOrCreate</a> </li> <li class="depth-4"> <a href="#1424">update</a> </li> <li class="depth-4"> <a href="#1418">updateAll</a> </li> <li class="depth-4"> <a href="#1349">updateOrCreate</a> </li> <li class="depth-4"> <a href="#1344">upsert</a> </li> <li class="depth-4"> <a href="#1359">upsertWithWhere</a> </li> <li class="depth-3"> <a href="#juggler.ColumnMetadata">Interface: juggler.ColumnMetadata</a> </li> <li class="depth-3"> <a href="#juggler.Condition">Interface: juggler.Condition</a> </li> <li class="depth-3"> <a href="#juggler.Count">Interface: juggler.Count</a> </li> <li class="depth-3"> <a href="#juggler.Fields">Interface: juggler.Fields</a> </li> <li class="depth-3"> <a href="#juggler.Filter">Interface: juggler.Filter</a> </li> <li class="depth-3"> <a href="#juggler.IdDefinition">Interface: juggler.IdDefinition</a> </li> <li class="depth-3"> <a href="#juggler.Inclusion">Interface: juggler.Inclusion</a> </li> <li class="depth-3"> <a href="#juggler.IndexDefinition">Interface: juggler.IndexDefinition</a> </li> <li class="depth-3"> <a href="#juggler.PropertyDefinition">Interface: juggler.PropertyDefinition</a> </li> <li class="depth-3"> <a href="#juggler.RelationDefinition">Interface: juggler.RelationDefinition</a> </li> <li class="depth-3"> <a href="#juggler.Schema">Interface: juggler.Schema</a> </li> <li class="depth-3"> <a href="#juggler.Where">Interface: juggler.Where</a> </li> <li class="depth-3"> <a href="#juggler.KVData">Type alias: juggler.KVData</a> </li> <li class="depth-3"> <a href="#juggler.ModelData">Type alias: juggler.ModelData</a> </li> <li class="depth-3"> <a href="#juggler.PersistedData">Type alias: juggler.PersistedData</a> </li> <li class="depth-3"> <a href="#juggler.PromiseOrVoid">Type alias: juggler.PromiseOrVoid</a> </li> <li class="depth-3"> <a href="#MixinBuilder">Class: MixinBuilder</a> </li> <li class="depth-4"> <a href="#1703">constructor</a> </li> <li class="depth-4"> <a href="#1707">with</a> </li> <li class="depth-4"> <a href="#1710">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="#1726">component</a> </li> <li class="depth-4"> <a href="#1722">dataSource</a> </li> <li class="depth-4"> <a href="#1718">getRepository</a> </li> <li class="depth-4"> <a href="#1729">mountComponentRepository</a> </li> <li class="depth-4"> <a href="#1715">repository</a> </li> <li class="depth-3"> <a href="#1825">Function: 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-3"> <a href="#Model">Class: Model</a> </li> <li class="depth-4"> <a href="#310">constructor</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="#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-3"> <a href="#Persistable">Interface: Persistable</a> </li> <li class="depth-3"> <a href="#PropertyDefinition">Interface: PropertyDefinition</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-3"> <a href="#EntityData">Type alias: EntityData</a> </li> <li class="depth-3"> <a href="#PropertyType">Type alias: PropertyType</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="#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="#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-3"> <a href="#Fields">Interface: Fields</a> </li> <li class="depth-3"> <a href="#Filter">Interface: Filter</a> </li> <li class="depth-3"> <a href="#Inclusion">Interface: Inclusion</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-3"> <a href="#Direction">Type alias: Direction</a> </li> <li class="depth-3"> <a href="#498">Function: filterTemplate</a> </li> <li class="depth-3"> <a href="#KVRepository">Interface: KVRepository</a> </li> <li class="depth-4"> <a href="#950">delete</a> </li> <li class="depth-4"> <a href="#954">deleteAll</a> </li> <li class="depth-4"> <a href="#966">expire</a> </li> <li class="depth-4"> <a href="#957">get</a> </li> <li class="depth-4"> <a href="#979">iterateKeys</a> </li> <li class="depth-4"> <a href="#976">keys</a> </li> <li class="depth-4"> <a href="#961">set</a> </li> <li class="depth-4"> <a href="#971">ttl</a> </li> <li class="depth-3"> <a href="#DefaultCrudRepository">Class: DefaultCrudRepository</a> </li> <li class="depth-4"> <a href="#1578">constructor</a> </li> <li class="depth-4"> <a href="#1644">count</a> </li> <li class="depth-4"> <a href="#1588">create</a> </li> <li class="depth-4"> <a href="#1592">createAll</a> </li> <li class="depth-4"> <a href="#1617">delete</a> </li> <li class="depth-4"> <a href="#1636">deleteAll</a> </li> <li class="depth-4"> <a href="#1640">deleteById</a> </li> <li class="depth-4"> <a href="#1652">execute</a> </li> <li class="depth-4"> <a href="#1648">exists</a> </li> <li class="depth-4"> <a href="#1600">find</a> </li> <li class="depth-4"> <a href="#1608">findById</a> </li> <li class="depth-4"> <a href="#1604">findOne</a> </li> <li class="depth-4"> <a href="#1631">replaceById</a> </li> <li class="depth-4"> <a href="#1596">save</a> </li> <li class="depth-4"> <a href="#1613">update</a> </li> <li class="depth-4"> <a href="#1621">updateAll</a> </li> <li class="depth-4"> <a href="#1626">updateById</a> </li> <li class="depth-3"> <a href="#DataSourceType">Type alias: DataSourceType</a> </li> <li class="depth-3"> <a href="#1661">Function: bindModel</a> </li> <li class="depth-3"> <a href="#CrudRepositoryImpl">Class: CrudRepositoryImpl</a> </li> <li class="depth-4"> <a href="#877">constructor</a> </li> <li class="depth-4"> <a href="#934">count</a> </li> <li class="depth-4"> <a href="#883">create</a> </li> <li class="depth-4"> <a href="#887">createAll</a> </li> <li class="depth-4"> <a href="#907">delete</a> </li> <li class="depth-4"> <a href="#926">deleteAll</a> </li> <li class="depth-4"> <a href="#930">deleteById</a> </li> <li class="depth-4"> <a href="#942">execute</a> </li> <li class="depth-4"> <a href="#938">exists</a> </li> <li class="depth-4"> <a href="#895">find</a> </li> <li class="depth-4"> <a href="#899">findById</a> </li> <li class="depth-4"> <a href="#921">replaceById</a> </li> <li class="depth-4"> <a href="#891">save</a> </li> <li class="depth-4"> <a href="#903">update</a> </li> <li class="depth-4"> <a href="#911">updateAll</a> </li> <li class="depth-4"> <a href="#916">updateById</a> </li> <li class="depth-3"> <a href="#CrudRepository">Interface: CrudRepository</a> </li> <li class="depth-4"> <a href="#789">count</a> </li> <li class="depth-4"> <a href="#768">create</a> </li> <li class="depth-4"> <a href="#772">createAll</a> </li> <li class="depth-4"> <a href="#785">deleteAll</a> </li> <li class="depth-4"> <a href="#776">find</a> </li> <li class="depth-4"> <a href="#780">updateAll</a> </li> <li class="depth-3"> <a href="#EntityCrudRepository">Interface: EntityCrudRepository</a> </li> <li class="depth-4"> <a href="#817">delete</a> </li> <li class="depth-4"> <a href="#836">deleteById</a> </li> <li class="depth-4"> <a href="#840">exists</a> </li> <li class="depth-4"> <a href="#821">findById</a> </li> <li class="depth-4"> <a href="#831">replaceById</a> </li> <li class="depth-4"> <a href="#809">save</a> </li> <li class="depth-4"> <a href="#813">update</a> </li> <li class="depth-4"> <a href="#826">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="#761">execute</a> </li> <li class="depth-3"> <a href="#AnyType">Class: AnyType</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="#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="#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="#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="#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="#ModelType">Class: ModelType</a> </li> <li class="depth-4"> <a href="#224">constructor</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="#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="#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="#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="#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="#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>  <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>  <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: undefined) : T</h4>  <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">args</strong> </td> <td class="code-arg-types"> <code></code> </td> <td class="code-arg-desc">  <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>  <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: 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></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>  <div class="code-desc"> <p><p>Common properties/operations for connectors</p> </p> <p></p> </div> </section> <section class="code-doc"> <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-desc">Description</th> </tr> <tr class="code-arg"> <td> <a name=""></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-desc">  <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">interfaces</strong> </td> <td class="code-arg-types"> <code></code> </td> <td class="code-arg-desc">  <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">name</strong> </td> <td class="code-arg-types"> <code>string</code> </td> <td class="code-arg-desc">  <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() : Promise</h4>  </section> <section class="code-doc "> <a name="359"></a> <h4 class="code-ref">disconnect() : Promise</h4>  </section> <section class="code-doc "> <a name="363"></a> <h4 class="code-ref">execute(command: <a href="#Command">Command</a>, parameters: undefined, options: <a href="#Options">Options</a>) : Promise</h4>  <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">command</strong> </td> <td class="code-arg-types"> <code><a href="#Command">Command</a></code> </td> <td class="code-arg-desc">  <div class="code-desc"> <p><p>Common properties/operations for connectors</p> </p> <p></p> </div> </td> </tr> <tr class="code-arg"> <td> <strong class="code-arg-name">parameters</strong> </td> <td class="code-arg-types"> <code></code> </td> <td class="code-arg-desc">  <div class="code-desc"> <p><p>Common properties/operations for connectors</p> </p> <p></p> </div> </td> </tr> <tr class="code-arg"> <td> <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-desc">  <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() : Promise</h4>  </section> <section class="code-doc "> <a name="CrudConnector"></a> <h3 class="code-ref">Interface: CrudConnector</h3>  <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>, where: <a href="#Where">Where</a>, options: <a href="#Options">Options</a>) : Promise</h4>  <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> <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">modelClass</strong> </td> <td class="code-arg-types"> <code><a href="#Class">Class</a></code> </td> <td class="code-arg-desc">  <div class="code-desc"> <p></p> <p><p>The model class</p> </p> </div> </td> </tr> <tr class="code-arg"> <td> <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-desc">  <div class="code-desc"> <p></p> <p><p>The matching criteria</p> </p> </div> </td> </tr> <tr class="code-arg"> <td> <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-desc">  <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>, entity: <a href="#EntityData">EntityData</a>, options: <a href="#Options">Options</a>) : Promise</h4>  <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> <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">modelClass</strong> </td> <td class="code-arg-types"> <code><a href="#Class">Class</a></code> </td> <td class="code-arg-desc">  <div class="code-desc"> <p></p> <p><p>The model class</p> </p> </div> </td> </tr> <tr class="code-arg"> <td> <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-desc">  <div class="code-desc"> <p></p> <p><p>The entity instance or data</p> </p> </div> </td> </tr> <tr class="code-arg"> <td> <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-desc">  <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="509"></a> <h4 class="code-ref">createAll(modelClass: <a href="#Class">Class</a>, entities: undefined, options: <a href="#Options">Options</a>) : Promise</h4>  <div class="code-desc"> <p><p>Create multiple entities</p> </p> <p></p> </div> Returns: <p><p>A promise of an array of entities created</p> </p> <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">modelClass</strong> </td> <td class="code-arg-types"> <code><a href="#Class">Class</a></code> </td> <td class="code-arg-desc">  <div class="code-desc"> <p></p> <p><p>The model class</p> </p> </div> </td> </tr> <tr class="code-arg"> <td> <strong class="code-arg-name">entities</strong> </td> <td class="code-arg-types"> <code></code> </td> <td class="code-arg-desc">  <div class="code-desc"> <p></p> <p><p>An array of entity instances or data</p> </p> </div> </td> </tr> <tr class="code-arg"> <td> <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-desc">  <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="535"></a> <h4 class="code-ref">delete(modelClass: <a href="#Class">Class</a>, entity: <a href="#EntityData">EntityData</a>, options: <a href="#Options">Options</a>) : Promise</h4>  <div class="code-desc"> <p><p>Delete an entity</p> </p> <p></p> </div> Returns: <p><p>Promise<true> if an entity is deleted, otherwise Promise<false></p> </p> <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-