@loopback/docs
Version:
Documentation for LoopBack 4
2,051 lines (1,511 loc) • 666 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="#Class.constructor">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="#DeepPartial">Type: DeepPartial</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="#Connector.prototype.configModel">configModel</a>
</li>
<li class="depth-4">
<a href="#Connector.prototype.interfaces">interfaces</a>
</li>
<li class="depth-4">
<a href="#Connector.prototype.name">name</a>
</li>
<li class="depth-4">
<a href="#Connector.prototype.connect">connect()</a>
</li>
<li class="depth-4">
<a href="#Connector.prototype.disconnect">disconnect()</a>
</li>
<li class="depth-4">
<a href="#Connector.prototype.execute">execute()</a>
</li>
<li class="depth-4">
<a href="#Connector.prototype.ping">ping()</a>
</li>
<li class="depth-3">
<a href="#CrudConnector">Interface: CrudConnector</a>
</li>
<li class="depth-4">
<a href="#CrudConnector.prototype.count">count()</a>
</li>
<li class="depth-4">
<a href="#CrudConnector.prototype.create">create()</a>
</li>
<li class="depth-4">
<a href="#CrudConnector.prototype.createAll">createAll()</a>
</li>
<li class="depth-4">
<a href="#CrudConnector.prototype.delete">delete()</a>
</li>
<li class="depth-4">
<a href="#CrudConnector.prototype.deleteAll">deleteAll()</a>
</li>
<li class="depth-4">
<a href="#CrudConnector.prototype.deleteById">deleteById()</a>
</li>
<li class="depth-4">
<a href="#CrudConnector.prototype.exists">exists()</a>
</li>
<li class="depth-4">
<a href="#CrudConnector.prototype.find">find()</a>
</li>
<li class="depth-4">
<a href="#CrudConnector.prototype.findById">findById()</a>
</li>
<li class="depth-4">
<a href="#CrudConnector.prototype.replaceById">replaceById()</a>
</li>
<li class="depth-4">
<a href="#CrudConnector.prototype.save">save()</a>
</li>
<li class="depth-4">
<a href="#CrudConnector.prototype.update">update()</a>
</li>
<li class="depth-4">
<a href="#CrudConnector.prototype.updateAll">updateAll()</a>
</li>
<li class="depth-4">
<a href="#CrudConnector.prototype.updateById">updateById()</a>
</li>
<li class="depth-3">
<a href="#KVConnector">Interface: KVConnector</a>
</li>
<li class="depth-4">
<a href="#KVConnector.prototype.delete">delete()</a>
</li>
<li class="depth-4">
<a href="#KVConnector.prototype.deleteAll">deleteAll()</a>
</li>
<li class="depth-4">
<a href="#KVConnector.prototype.expire">expire()</a>
</li>
<li class="depth-4">
<a href="#KVConnector.prototype.get">get()</a>
</li>
<li class="depth-4">
<a href="#KVConnector.prototype.iterateKeys">iterateKeys()</a>
</li>
<li class="depth-4">
<a href="#KVConnector.prototype.keys">keys()</a>
</li>
<li class="depth-4">
<a href="#KVConnector.prototype.set">set()</a>
</li>
<li class="depth-4">
<a href="#KVConnector.prototype.ttl">ttl()</a>
</li>
<li class="depth-3">
<a href="#DataSource">Interface: DataSource</a>
</li>
<li class="depth-4">
<a href="#DataSource.prototype.connector">connector</a>
</li>
<li class="depth-4">
<a href="#DataSource.prototype.name">name</a>
</li>
<li class="depth-4">
<a href="#DataSource.prototype.settings">settings</a>
</li>
<li class="depth-3">
<a href="#ModelMetadataHelper">Class: ModelMetadataHelper</a>
</li>
<li class="depth-4">
<a href="#ModelMetadataHelper.getModelMetadata">static getModelMetadata()</a>
</li>
<li class="depth-3">
<a href="#property">Namespace: property</a>
</li>
<li class="depth-4">
<a href="#property.ERR_NO_ARGS">ERR_NO_ARGS</a>
</li>
<li class="depth-4">
<a href="#property.ERR_PROP_NOT_ARRAY">ERR_PROP_NOT_ARRAY</a>
</li>
<li class="depth-4">
<a href="#property.array">array()</a>
</li>
<li class="depth-3">
<a href="#PropertyMap">Type: PropertyMap</a>
</li>
<li class="depth-3">
<a href="#RelationMap">Type: RelationMap</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="#model">model()</a>
</li>
<li class="depth-3">
<a href="#RelationType">Enum: RelationType</a>
</li>
<li class="depth-4">
<a href="#RelationType.belongsTo">belongsTo</a>
</li>
<li class="depth-4">
<a href="#RelationType.embedsMany">embedsMany</a>
</li>
<li class="depth-4">
<a href="#RelationType.embedsOne">embedsOne</a>
</li>
<li class="depth-4">
<a href="#RelationType.hasMany">hasMany</a>
</li>
<li class="depth-4">
<a href="#RelationType.hasOne">hasOne</a>
</li>
<li class="depth-4">
<a href="#RelationType.referencesMany">referencesMany</a>
</li>
<li class="depth-4">
<a href="#RelationType.referencesOne">referencesOne</a>
</li>
<li class="depth-3">
<a href="#RelationMetadata">Class: RelationMetadata</a>
</li>
<li class="depth-4">
<a href="#RelationMetadata.prototype.as">as</a>
</li>
<li class="depth-4">
<a href="#RelationMetadata.prototype.target">target</a>
</li>
<li class="depth-4">
<a href="#RelationMetadata.prototype.type">type</a>
</li>
<li class="depth-3">
<a href="#HasManyDefinition">Interface: HasManyDefinition</a>
</li>
<li class="depth-4">
<a href="#HasManyDefinition.prototype.keyTo">keyTo</a>
</li>
<li class="depth-4">
<a href="#HasManyDefinition.prototype.type">type</a>
</li>
<li class="depth-3">
<a href="#RelationDefinitionBase">Interface: RelationDefinitionBase</a>
</li>
<li class="depth-4">
<a href="#RelationDefinitionBase.prototype.type">type</a>
</li>
<li class="depth-3">
<a href="#RELATIONS_KEY">RELATIONS_KEY</a>
</li>
<li class="depth-3">
<a href="#belongsTo">belongsTo()</a>
</li>
<li class="depth-3">
<a href="#embedsMany">embedsMany()</a>
</li>
<li class="depth-3">
<a href="#embedsOne">embedsOne()</a>
</li>
<li class="depth-3">
<a href="#hasMany">hasMany()</a>
</li>
<li class="depth-3">
<a href="#hasOne">hasOne()</a>
</li>
<li class="depth-3">
<a href="#referencesMany">referencesMany()</a>
</li>
<li class="depth-3">
<a href="#referencesOne">referencesOne()</a>
</li>
<li class="depth-3">
<a href="#relation">relation()</a>
</li>
<li class="depth-3">
<a href="#RepositoryMetadata">Class: RepositoryMetadata</a>
</li>
<li class="depth-4">
<a href="#RepositoryMetadata.constructor">constructor()</a>
</li>
<li class="depth-4">
<a href="#RepositoryMetadata.prototype.dataSource">dataSource</a>
</li>
<li class="depth-4">
<a href="#RepositoryMetadata.prototype.dataSourceName">dataSourceName</a>
</li>
<li class="depth-4">
<a href="#RepositoryMetadata.prototype.modelClass">modelClass</a>
</li>
<li class="depth-4">
<a href="#RepositoryMetadata.prototype.modelName">modelName</a>
</li>
<li class="depth-4">
<a href="#RepositoryMetadata.prototype.name">name</a>
</li>
<li class="depth-3">
<a href="#RepositoryDecorator">Type: RepositoryDecorator</a>
</li>
<li class="depth-3">
<a href="#repository">repository()</a>
</li>
<li class="depth-3">
<a href="#RepositoryMixinDoc">Class: RepositoryMixinDoc</a>
</li>
<li class="depth-4">
<a href="#RepositoryMixinDoc.constructor">constructor()</a>
</li>
<li class="depth-4">
<a href="#RepositoryMixinDoc.prototype.component">component()</a>
</li>
<li class="depth-4">
<a href="#RepositoryMixinDoc.prototype.dataSource">dataSource()</a>
</li>
<li class="depth-4">
<a href="#RepositoryMixinDoc.prototype.getRepository">getRepository()</a>
</li>
<li class="depth-4">
<a href="#RepositoryMixinDoc.prototype.mountComponentRepository">mountComponentRepository()</a>
</li>
<li class="depth-4">
<a href="#RepositoryMixinDoc.prototype.repository">repository()</a>
</li>
<li class="depth-3">
<a href="#ApplicationWithRepositories">Interface: ApplicationWithRepositories</a>
</li>
<li class="depth-4">
<a href="#ApplicationWithRepositories.prototype.options">options</a>
</li>
<li class="depth-4">
<a href="#ApplicationWithRepositories.prototype.component">component()</a>
</li>
<li class="depth-4">
<a href="#ApplicationWithRepositories.prototype.dataSource">dataSource()</a>
</li>
<li class="depth-4">
<a href="#ApplicationWithRepositories.prototype.getRepository">getRepository()</a>
</li>
<li class="depth-4">
<a href="#ApplicationWithRepositories.prototype.mountComponentRepositories">mountComponentRepositories()</a>
</li>
<li class="depth-4">
<a href="#ApplicationWithRepositories.prototype.repository">repository()</a>
</li>
<li class="depth-3">
<a href="#RepositoryMixin">RepositoryMixin()</a>
</li>
<li class="depth-3">
<a href="#Entity">Class: Entity</a>
</li>
<li class="depth-4">
<a href="#Entity.prototype.getId">getId()</a>
</li>
<li class="depth-4">
<a href="#Entity.prototype.getIdObject">getIdObject()</a>
</li>
<li class="depth-4">
<a href="#Entity.buildWhereForId">static buildWhereForId()</a>
</li>
<li class="depth-4">
<a href="#Entity.getIdOf">static getIdOf()</a>
</li>
<li class="depth-3">
<a href="#Event">Class: Event</a>
</li>
<li class="depth-4">
<a href="#Event.prototype.source">source</a>
</li>
<li class="depth-4">
<a href="#Event.prototype.type">type</a>
</li>
<li class="depth-3">
<a href="#Model">Class: Model</a>
</li>
<li class="depth-4">
<a href="#Model.constructor">constructor()</a>
</li>
<li class="depth-4">
<a href="#Model.definition">static definition</a>
</li>
<li class="depth-4">
<a href="#Model.modelName">>modelName</a>
</li>
<li class="depth-4">
<a href="#Model.prototype.toJSON">toJSON()</a>
</li>
<li class="depth-4">
<a href="#Model.prototype.toObject">toObject()</a>
</li>
<li class="depth-3">
<a href="#ModelDefinition">Class: ModelDefinition</a>
</li>
<li class="depth-4">
<a href="#ModelDefinition.constructor">constructor()</a>
</li>
<li class="depth-4">
<a href="#ModelDefinition.prototype.name">name</a>
</li>
<li class="depth-4">
<a href="#ModelDefinition.prototype.properties">properties</a>
</li>
<li class="depth-4">
<a href="#ModelDefinition.prototype.relations">relations</a>
</li>
<li class="depth-4">
<a href="#ModelDefinition.prototype.settings">settings</a>
</li>
<li class="depth-4">
<a href="#ModelDefinition.prototype.addProperty">addProperty()</a>
</li>
<li class="depth-4">
<a href="#ModelDefinition.prototype.addSetting">addSetting()</a>
</li>
<li class="depth-4">
<a href="#ModelDefinition.prototype.idProperties">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="#ModelDefinitionSyntax.prototype.name">name</a>
</li>
<li class="depth-4">
<a href="#ModelDefinitionSyntax.prototype.properties">properties</a>
</li>
<li class="depth-4">
<a href="#ModelDefinitionSyntax.prototype.relations">relations</a>
</li>
<li class="depth-4">
<a href="#ModelDefinitionSyntax.prototype.settings">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="#PropertyDefinition.prototype.id">id</a>
</li>
<li class="depth-4">
<a href="#PropertyDefinition.prototype.itemType">itemType</a>
</li>
<li class="depth-4">
<a href="#PropertyDefinition.prototype.json">json</a>
</li>
<li class="depth-4">
<a href="#PropertyDefinition.prototype.store">store</a>
</li>
<li class="depth-4">
<a href="#PropertyDefinition.prototype.type">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="#PropertyForm.prototype.in">in</a>
</li>
<li class="depth-4">
<a href="#PropertyForm.prototype.name">name</a>
</li>
<li class="depth-4">
<a href="#PropertyForm.prototype.out">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="#Operators.and">and</a>
</li>
<li class="depth-4">
<a href="#Operators.between">between</a>
</li>
<li class="depth-4">
<a href="#Operators.eq">eq</a>
</li>
<li class="depth-4">
<a href="#Operators.exists">exists</a>
</li>
<li class="depth-4">
<a href="#Operators.gt">gt</a>
</li>
<li class="depth-4">
<a href="#Operators.gte">gte</a>
</li>
<li class="depth-4">
<a href="#Operators.inq">inq</a>
</li>
<li class="depth-4">
<a href="#Operators.lt">lt</a>
</li>
<li class="depth-4">
<a href="#Operators.lte">lte</a>
</li>
<li class="depth-4">
<a href="#Operators.neq">neq</a>
</li>
<li class="depth-4">
<a href="#Operators.or">or</a>
</li>
<li class="depth-3">
<a href="#FilterBuilder">Class: FilterBuilder</a>
</li>
<li class="depth-4">
<a href="#FilterBuilder.constructor">constructor()</a>
</li>
<li class="depth-4">
<a href="#FilterBuilder.prototype.filter">filter</a>
</li>
<li class="depth-4">
<a href="#FilterBuilder.prototype.build">build()</a>
</li>
<li class="depth-4">
<a href="#FilterBuilder.prototype.fields">fields()</a>
</li>
<li class="depth-4">
<a href="#FilterBuilder.prototype.impose">impose()</a>
</li>
<li class="depth-4">
<a href="#FilterBuilder.prototype.include">include()</a>
</li>
<li class="depth-4">
<a href="#FilterBuilder.prototype.limit">limit()</a>
</li>
<li class="depth-4">
<a href="#FilterBuilder.prototype.offset">offset()</a>
</li>
<li class="depth-4">
<a href="#FilterBuilder.prototype.order">order()</a>
</li>
<li class="depth-4">
<a href="#FilterBuilder.prototype.skip">skip()</a>
</li>
<li class="depth-4">
<a href="#FilterBuilder.prototype.where">where()</a>
</li>
<li class="depth-3">
<a href="#WhereBuilder">Class: WhereBuilder</a>
</li>
<li class="depth-4">
<a href="#WhereBuilder.constructor">constructor()</a>
</li>
<li class="depth-4">
<a href="#WhereBuilder.prototype.where">where</a>
</li>
<li class="depth-4">
<a href="#WhereBuilder.prototype.and">and()</a>
</li>
<li class="depth-4">
<a href="#WhereBuilder.prototype.between">between()</a>
</li>
<li class="depth-4">
<a href="#WhereBuilder.prototype.build">build()</a>
</li>
<li class="depth-4">
<a href="#WhereBuilder.prototype.eq">eq()</a>
</li>
<li class="depth-4">
<a href="#WhereBuilder.prototype.exists">exists()</a>
</li>
<li class="depth-4">
<a href="#WhereBuilder.prototype.gt">gt()</a>
</li>
<li class="depth-4">
<a href="#WhereBuilder.prototype.gte">gte()</a>
</li>
<li class="depth-4">
<a href="#WhereBuilder.prototype.impose">impose()</a>
</li>
<li class="depth-4">
<a href="#WhereBuilder.prototype.inq">inq()</a>
</li>
<li class="depth-4">
<a href="#WhereBuilder.prototype.lt">lt()</a>
</li>
<li class="depth-4">
<a href="#WhereBuilder.prototype.lte">lte()</a>
</li>
<li class="depth-4">
<a href="#WhereBuilder.prototype.neq">neq()</a>
</li>
<li class="depth-4">
<a href="#WhereBuilder.prototype.or">or()</a>
</li>
<li class="depth-3">
<a href="#Condition">Interface: Condition</a>
</li>
<li class="depth-4">
<a href="#Condition.prototype.and">and</a>
</li>
<li class="depth-4">
<a href="#Condition.prototype.between">between</a>
</li>
<li class="depth-4">
<a href="#Condition.prototype.eq">eq</a>
</li>
<li class="depth-4">
<a href="#Condition.prototype.exists">exists</a>
</li>
<li class="depth-4">
<a href="#Condition.prototype.gt">gt</a>
</li>
<li class="depth-4">
<a href="#Condition.prototype.gte">gte</a>
</li>
<li class="depth-4">
<a href="#Condition.prototype.inq">inq</a>
</li>
<li class="depth-4">
<a href="#Condition.prototype.lt">lt</a>
</li>
<li class="depth-4">
<a href="#Condition.prototype.lte">lte</a>
</li>
<li class="depth-4">
<a href="#Condition.prototype.neq">neq</a>
</li>
<li class="depth-4">
<a href="#Condition.prototype.or">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="#Filter.prototype.fields">fields</a>
</li>
<li class="depth-4">
<a href="#Filter.prototype.include">include</a>
</li>
<li class="depth-4">
<a href="#Filter.prototype.limit">limit</a>
</li>
<li class="depth-4">
<a href="#Filter.prototype.offset">offset</a>
</li>
<li class="depth-4">
<a href="#Filter.prototype.order">order</a>
</li>
<li class="depth-4">
<a href="#Filter.prototype.skip">skip</a>
</li>
<li class="depth-4">
<a href="#Filter.prototype.where">where</a>
</li>
<li class="depth-3">
<a href="#Inclusion">Interface: Inclusion</a>
</li>
<li class="depth-4">
<a href="#Inclusion.prototype.relation">relation</a>
</li>
<li class="depth-4">
<a href="#Inclusion.prototype.scope">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="#Where.prototype.and">and</a>
</li>
<li class="depth-4">
<a href="#Where.prototype.or">or</a>
</li>
<li class="depth-3">
<a href="#Direction">Type: Direction</a>
</li>
<li class="depth-3">
<a href="#filterTemplate">filterTemplate()</a>
</li>
<li class="depth-3">
<a href="#isFilter">isFilter()</a>
</li>
<li class="depth-3">
<a href="#constrainDataObject">constrainDataObject()</a>
</li>
<li class="depth-3">
<a href="#constrainDataObjects">constrainDataObjects()</a>
</li>
<li class="depth-3">
<a href="#constrainFilter">constrainFilter()</a>
</li>
<li class="depth-3">
<a href="#constrainWhere">constrainWhere()</a>
</li>
<li class="depth-3">
<a href="#KeyValueRepository">Interface: KeyValueRepository</a>
</li>
<li class="depth-4">
<a href="#KeyValueRepository.prototype.delete">delete()</a>
</li>
<li class="depth-4">
<a href="#KeyValueRepository.prototype.deleteAll">deleteAll()</a>
</li>
<li class="depth-4">
<a href="#KeyValueRepository.prototype.expire">expire()</a>
</li>
<li class="depth-4">
<a href="#KeyValueRepository.prototype.get">get()</a>
</li>
<li class="depth-4">
<a href="#KeyValueRepository.prototype.keys">keys()</a>
</li>
<li class="depth-4">
<a href="#KeyValueRepository.prototype.set">set()</a>
</li>
<li class="depth-4">
<a href="#KeyValueRepository.prototype.ttl">ttl()</a>
</li>
<li class="depth-3">
<a href="#KeyValueFilter">Type: KeyValueFilter</a>
</li>
<li class="depth-3">
<a href="#juggler">Namespace: juggler</a>
</li>
<li class="depth-3">
<a href="#DefaultCrudRepository">Class: DefaultCrudRepository</a>
</li>
<li class="depth-4">
<a href="#DefaultCrudRepository.constructor">constructor()</a>
</li>
<li class="depth-4">
<a href="#DefaultCrudRepository.prototype.dataSource">dataSource</a>
</li>
<li class="depth-4">
<a href="#DefaultCrudRepository.prototype.entityClass">entityClass</a>
</li>
<li class="depth-4">
<a href="#DefaultCrudRepository.prototype.modelClass">modelClass</a>
</li>
<li class="depth-4">
<a href="#DefaultCrudRepository.prototype.count">count()</a>
</li>
<li class="depth-4">
<a href="#DefaultCrudRepository.prototype.create">create()</a>
</li>
<li class="depth-4">
<a href="#DefaultCrudRepository.prototype.createAll">createAll()</a>
</li>
<li class="depth-4">
<a href="#DefaultCrudRepository.prototype.delete">delete()</a>
</li>
<li class="depth-4">
<a href="#DefaultCrudRepository.prototype.deleteAll">deleteAll()</a>
</li>
<li class="depth-4">
<a href="#DefaultCrudRepository.prototype.deleteById">deleteById()</a>
</li>
<li class="depth-4">
<a href="#DefaultCrudRepository.prototype.execute">execute()</a>
</li>
<li class="depth-4">
<a href="#DefaultCrudRepository.prototype.exists">exists()</a>
</li>
<li class="depth-4">
<a href="#DefaultCrudRepository.prototype.find">find()</a>
</li>
<li class="depth-4">
<a href="#DefaultCrudRepository.prototype.findById">findById()</a>
</li>
<li class="depth-4">
<a href="#DefaultCrudRepository.prototype.findOne">findOne()</a>
</li>
<li class="depth-4">
<a href="#DefaultCrudRepository.prototype.replaceById">replaceById()</a>
</li>
<li class="depth-4">
<a href="#DefaultCrudRepository.prototype.save">save()</a>
</li>
<li class="depth-4">
<a href="#DefaultCrudRepository.prototype.update">update()</a>
</li>
<li class="depth-4">
<a href="#DefaultCrudRepository.prototype.updateAll">updateAll()</a>
</li>
<li class="depth-4">
<a href="#DefaultCrudRepository.prototype.updateById">updateById()</a>
</li>
<li class="depth-3">
<a href="#bindModel">bindModel()</a>
</li>
<li class="depth-3">
<a href="#ensurePromise">ensurePromise()</a>
</li>
<li class="depth-3">
<a href="#HasManyRepositoryFactory">Type: HasManyRepositoryFactory</a>
</li>
<li class="depth-3">
<a href="#createHasManyRepositoryFactory">createHasManyRepositoryFactory()</a>
</li>
<li class="depth-3">
<a href="#DefaultHasManyEntityCrudRepository">Class: DefaultHasManyEntityCrudRepository</a>
</li>
<li class="depth-4">
<a href="#DefaultHasManyEntityCrudRepository.constructor">constructor()</a>
</li>
<li class="depth-4">
<a href="#DefaultHasManyEntityCrudRepository.prototype.constraint">constraint</a>
</li>
<li class="depth-4">
<a href="#DefaultHasManyEntityCrudRepository.prototype.targetRepository">targetRepository</a>
</li>
<li class="depth-4">
<a href="#DefaultHasManyEntityCrudRepository.prototype.create">create()</a>
</li>
<li class="depth-4">
<a href="#DefaultHasManyEntityCrudRepository.prototype.delete">delete()</a>
</li>
<li class="depth-4">
<a href="#DefaultHasManyEntityCrudRepository.prototype.find">find()</a>
</li>
<li class="depth-4">
<a href="#DefaultHasManyEntityCrudRepository.prototype.patch">patch()</a>
</li>
<li class="depth-3">
<a href="#HasManyRepository">Interface: HasManyRepository</a>
</li>
<li class="depth-4">
<a href="#HasManyRepository.prototype.create">create()</a>
</li>
<li class="depth-4">
<a href="#HasManyRepository.prototype.delete">delete()</a>
</li>
<li class="depth-4">
<a href="#HasManyRepository.prototype.find">find()</a>
</li>
<li class="depth-4">
<a href="#HasManyRepository.prototype.patch">patch()</a>
</li>
<li class="depth-3">
<a href="#CrudRepositoryImpl">Class: CrudRepositoryImpl</a>
</li>
<li class="depth-4">
<a href="#CrudRepositoryImpl.constructor">constructor()</a>
</li>
<li class="depth-4">
<a href="#CrudRepositoryImpl.prototype.dataSource">dataSource</a>
</li>
<li class="depth-4">
<a href="#CrudRepositoryImpl.prototype.model">model</a>
</li>
<li class="depth-4">
<a href="#CrudRepositoryImpl.prototype.count">count()</a>
</li>
<li class="depth-4">
<a href="#CrudRepositoryImpl.prototype.create">create()</a>
</li>
<li class="depth-4">
<a href="#CrudRepositoryImpl.prototype.createAll">createAll()</a>
</li>
<li class="depth-4">
<a href="#CrudRepositoryImpl.prototype.delete">delete()</a>
</li>
<li class="depth-4">
<a href="#CrudRepositoryImpl.prototype.deleteAll">deleteAll()</a>
</li>
<li class="depth-4">
<a href="#CrudRepositoryImpl.prototype.deleteById">deleteById()</a>
</li>
<li class="depth-4">
<a href="#CrudRepositoryImpl.prototype.execute">execute()</a>
</li>
<li class="depth-4">
<a href="#CrudRepositoryImpl.prototype.exists">exists()</a>
</li>
<li class="depth-4">
<a href="#CrudRepositoryImpl.prototype.find">find()</a>
</li>
<li class="depth-4">
<a href="#CrudRepositoryImpl.prototype.findById">findById()</a>
</li>
<li class="depth-4">
<a href="#CrudRepositoryImpl.prototype.replaceById">replaceById()</a>
</li>
<li class="depth-4">
<a href="#CrudRepositoryImpl.prototype.save">save()</a>
</li>
<li class="depth-4">
<a href="#CrudRepositoryImpl.prototype.update">update()</a>
</li>
<li class="depth-4">
<a href="#CrudRepositoryImpl.prototype.updateAll">updateAll()</a>
</li>
<li class="depth-4">
<a href="#CrudRepositoryImpl.prototype.updateById">updateById()</a>
</li>
<li class="depth-3">
<a href="#CrudRepository">Interface: CrudRepository</a>
</li>
<li class="depth-4">
<a href="#CrudRepository.prototype.count">count()</a>
</li>
<li class="depth-4">
<a href="#CrudRepository.prototype.create">create()</a>
</li>
<li class="depth-4">
<a href="#CrudRepository.prototype.createAll">createAll()</a>
</li>
<li class="depth-4">
<a href="#CrudRepository.prototype.deleteAll">deleteAll()</a>
</li>
<li class="depth-4">
<a href="#CrudRepository.prototype.find">find()</a>
</li>
<li class="depth-4">
<a href="#CrudRepository.prototype.updateAll">updateAll()</a>
</li>
<li class="depth-3">
<a href="#EntityCrudRepository">Interface: EntityCrudRepository</a>
</li>
<li class="depth-4">
<a href="#EntityCrudRepository.prototype.delete">delete()</a>
</li>
<li class="depth-4">
<a href="#EntityCrudRepository.prototype.deleteById">deleteById()</a>
</li>
<li class="depth-4">
<a href="#EntityCrudRepository.prototype.exists">exists()</a>
</li>
<li class="depth-4">
<a href="#EntityCrudRepository.prototype.findById">findById()</a>
</li>
<li class="depth-4">
<a href="#EntityCrudRepository.prototype.replaceById">replaceById()</a>
</li>
<li class="depth-4">
<a href="#EntityCrudRepository.prototype.save">save()</a>
</li>
<li class="depth-4">
<a href="#EntityCrudRepository.prototype.update">update()</a>
</li>
<li class="depth-4">
<a href="#EntityCrudRepository.prototype.updateById">updateById()</a>
</li>
<li class="depth-3">
<a href="#EntityRepository">Interface: EntityRepository</a>
</li>
<li class="depth-3">
<a href="#ExecutableRepository">Interface: ExecutableRepository</a>
</li>
<li class="depth-4">
<a href="#ExecutableRepository.prototype.execute">execute()</a>
</li>
<li class="depth-3">
<a href="#Repository">Interface: Repository</a>
</li>
<li class="depth-3">
<a href="#AnyType">Class: AnyType</a>
</li>
<li class="depth-4">
<a href="#AnyType.prototype.name">name</a>
</li>
<li class="depth-4">
<a href="#AnyType.prototype.coerce">coerce()</a>
</li>
<li class="depth-4">
<a href="#AnyType.prototype.defaultValue">defaultValue()</a>
</li>
<li class="depth-4">
<a href="#AnyType.prototype.isCoercible">isCoercible()</a>
</li>
<li class="depth-4">
<a href="#AnyType.prototype.isInstance">isInstance()</a>
</li>
<li class="depth-4">
<a href="#AnyType.prototype.serialize">serialize()</a>
</li>
<li class="depth-3">
<a href="#ArrayType">Class: ArrayType</a>
</li>
<li class="depth-4">
<a href="#ArrayType.constructor">constructor()</a>
</li>
<li class="depth-4">
<a href="#ArrayType.prototype.itemType">itemType</a>
</li>
<li class="depth-4">
<a href="#ArrayType.prototype.name">name</a>
</li>
<li class="depth-4">
<a href="#ArrayType.prototype.coerce">coerce()</a>
</li>
<li class="depth-4">
<a href="#ArrayType.prototype.defaultValue">defaultValue()</a>
</li>
<li class="depth-4">
<a href="#ArrayType.prototype.isCoercible">isCoercible()</a>
</li>
<li class="depth-4">
<a href="#ArrayType.prototype.isInstance">isInstance()</a>
</li>
<li class="depth-4">
<a href="#ArrayType.prototype.serialize">serialize()</a>
</li>
<li class="depth-3">
<a href="#BooleanType">Class: BooleanType</a>
</li>
<li class="depth-4">
<a href="#BooleanType.prototype.name">name</a>
</li>
<li class="depth-4">
<a href="#BooleanType.prototype.coerce">coerce()</a>
</li>
<li class="depth-4">
<a href="#BooleanType.prototype.defaultValue">defaultValue()</a>
</li>
<li class="depth-4">
<a href="#BooleanType.prototype.isCoercible">isCoercible()</a>
</li>
<li class="depth-4">
<a href="#BooleanType.prototype.isInstance">isInstance()</a>
</li>
<li class="depth-4">
<a href="#BooleanType.prototype.serialize">serialize()</a>
</li>
<li class="depth-3">
<a href="#BufferType">Class: BufferType</a>
</li>
<li class="depth-4">
<a href="#BufferType.prototype.name">name</a>
</li>
<li class="depth-4">
<a href="#BufferType.prototype.coerce">coerce()</a>
</li>
<li class="depth-4">
<a href="#BufferType.prototype.defaultValue">defaultValue()</a>
</li>
<li class="depth-4">
<a href="#BufferType.prototype.isCoercible">isCoercible()</a>
</li>
<li class="depth-4">
<a href="#BufferType.prototype.isInstance">isInstance()</a>
</li>
<li class="depth-4">
<a href="#BufferType.prototype.serialize">serialize()</a>
</li>
<li class="depth-3">
<a href="#DateType">Class: DateType</a>
</li>
<li class="depth-4">
<a href="#DateType.prototype.name">name</a>
</li>
<li class="depth-4">
<a href="#DateType.prototype.coerce">coerce()</a>
</li>
<li class="depth-4">
<a href="#DateType.prototype.defaultValue">defaultValue()</a>
</li>
<li class="depth-4">
<a href="#DateType.prototype.isCoercible">isCoercible()</a>
</li>
<li class="depth-4">
<a href="#DateType.prototype.isInstance">isInstance()</a>
</li>
<li class="depth-4">
<a href="#DateType.prototype.serialize">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="#ModelType.constructor">constructor()</a>
</li>
<li class="depth-4">
<a href="#ModelType.prototype.modelClass">modelClass</a>
</li>
<li class="depth-4">
<a href="#ModelType.prototype.name">name</a>
</li>
<li class="depth-4">
<a href="#ModelType.prototype.serialize">serialize()</a>
</li>
<li class="depth-3">
<a href="#NumberType">Class: NumberType</a>
</li>
<li class="depth-4">
<a href="#NumberType.prototype.name">name</a>
</li>
<li class="depth-4">
<a href="#NumberType.prototype.coerce">coerce()</a>
</li>
<li class="depth-4">
<a href="#NumberType.prototype.defaultValue">defaultValue()</a>
</li>
<li class="depth-4">
<a href="#NumberType.prototype.isCoercible">isCoercible()</a>
</li>
<li class="depth-4">
<a href="#NumberType.prototype.isInstance">isInstance()</a>
</li>
<li class="depth-4">
<a href="#NumberType.prototype.serialize">serialize()</a>
</li>
<li class="depth-3">
<a href="#ObjectType">Class: ObjectType</a>
</li>
<li class="depth-4">
<a href="#ObjectType.constructor">constructor()</a>
</li>
<li class="depth-4">
<a href="#ObjectType.prototype.name">name</a>
</li>
<li class="depth-4">
<a href="#ObjectType.prototype.type">type</a>
</li>
<li class="depth-4">
<a href="#ObjectType.prototype.coerce">coerce()</a>
</li>
<li class="depth-4">
<a href="#ObjectType.prototype.defaultValue">defaultValue()</a>
</li>
<li class="depth-4">
<a href="#ObjectType.prototype.isCoercible">isCoercible()</a>
</li>
<li class="depth-4">
<a href="#ObjectType.prototype.isInstance">isInstance()</a>
</li>
<li class="depth-4">
<a href="#ObjectType.prototype.serialize">serialize()</a>
</li>
<li class="depth-3">
<a href="#StringType">Class: StringType</a>
</li>
<li class="depth-4">
<a href="#StringType.prototype.name">name</a>
</li>
<li class="depth-4">
<a href="#StringType.prototype.coerce">coerce()</a>
</li>
<li class="depth-4">
<a href="#StringType.prototype.defaultValue">defaultValue()</a>
</li>
<li class="depth-4">
<a href="#StringType.prototype.isCoercible">isCoercible()</a>
</li>
<li class="depth-4">
<a href="#StringType.prototype.isInstance">isInstance()</a>
</li>
<li class="depth-4">
<a href="#StringType.prototype.serialize">serialize()</a>
</li>
<li class="depth-3">
<a href="#Type">Interface: Type</a>
</li>
<li class="depth-4">
<a href="#Type.prototype.name">name</a>
</li>
<li class="depth-4">
<a href="#Type.prototype.coerce">coerce()</a>
</li>
<li class="depth-4">
<a href="#Type.prototype.defaultValue">defaultValue()</a>
</li>
<li class="depth-4">
<a href="#Type.prototype.isCoercible">isCoercible()</a>
</li>
<li class="depth-4">
<a href="#Type.prototype.isInstance">isInstance()</a>
</li>
<li class="depth-4">
<a href="#Type.prototype.serialize">serialize()</a>
</li>
<li class="depth-3">
<a href="#UnionType">Class: UnionType</a>
</li>
<li class="depth-4">
<a href="#UnionType.constructor">constructor()</a>
</li>
<li class="depth-4">
<a href="#UnionType.prototype.itemTypes">itemTypes</a>
</li>
<li class="depth-4">
<a href="#UnionType.prototype.name">name</a>
</li>
<li class="depth-4">
<a href="#UnionType.prototype.coerce">coerce()</a>
</li>
<li class="depth-4">
<a href="#UnionType.prototype.defaultValue">defaultValue()</a>
</li>
<li class="depth-4">
<a href="#UnionType.prototype.isCoercible">isCoercible()</a>
</li>
<li class="depth-4">
<a href="#UnionType.prototype.isInstance">isInstance()</a>
</li>
<li class="depth-4">
<a href="#UnionType.prototype.serialize">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="Class.constructor"></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="Options"></a>
<h3 class="code-ref">Type alias: Options = 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="Connector.prototype.configModel"></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="Connector.prototype.interfaces"></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="Connector.prototype.name"></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="Connector.prototype.connect"></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="Connector.prototype.disconnect"></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).
-->