@loopback/docs 5.1.1 → 5.1.3

package/site/apidocs/repository.hasmanyrepositoryfactory.md

@@ -21,8 +21,8 @@ export interface HasManyRepositoryFactory<Target extends Entity, ForeignKeyType>
 
 ## Properties
 
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [inclusionResolver](./repository.hasmanyrepositoryfactory.inclusionresolver.md) | [InclusionResolver](./repository.inclusionresolver.md)<!-- -->&lt;[Entity](./repository.entity.md)<!-- -->, Target&gt; | Use <code>resolver</code> property to obtain an InclusionResolver for this relation. |
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [inclusionResolver](./repository.hasmanyrepositoryfactory.inclusionresolver.md) |  | [InclusionResolver](./repository.inclusionresolver.md)<!-- -->&lt;[Entity](./repository.entity.md)<!-- -->, Target&gt; | Use <code>resolver</code> property to obtain an InclusionResolver for this relation. |
 
 

package/site/apidocs/repository.hasonedefinition.md

@@ -22,12 +22,12 @@ export interface HasOneDefinition extends RelationDefinitionBase
 
 ## Properties
 
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [keyFrom?](./repository.hasonedefinition.keyfrom.md) | string | <i>(Optional)</i> |
-|  [keyTo?](./repository.hasonedefinition.keyto.md) | string | <i>(Optional)</i> keyTo: The foreign key used by the target model for this relation. keyFrom: The source key used by the source model for this relation.<!-- -->E.g. when a Customer has one Address instance, then keyTo is "customerId". Note that "customerId" is the default FK assumed by the framework, users can provide a custom FK name by setting "keyTo". And Customer.id is keyFrom. keyFrom defaults to the id property of a model. Users can provide a custom source key name by setting "keyTo". |
-|  [polymorphic?](./repository.hasonedefinition.polymorphic.md) | boolean \| { discriminator: string; } | <i>(Optional)</i> The polymorphism of the target model. The discriminator is a key of source model. If the target model is not polymorphic, then the value should be left undefined or false; If the key on source model indicating the concrete class of the target instance is default i.e. camelCase(classNameOf(throughModelInstance)) + "Id" Then the discriminator field can be undefined |
-|  [targetsMany](./repository.hasonedefinition.targetsmany.md) | false |  |
-|  [type](./repository.hasonedefinition.type.md) | [RelationType.hasOne](./repository.relationtype.md) |  |
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [keyFrom?](./repository.hasonedefinition.keyfrom.md) |  | string | <i>(Optional)</i> |
+|  [keyTo?](./repository.hasonedefinition.keyto.md) |  | string | <p><i>(Optional)</i> keyTo: The foreign key used by the target model for this relation. keyFrom: The source key used by the source model for this relation.</p><p>E.g. when a Customer has one Address instance, then keyTo is "customerId". Note that "customerId" is the default FK assumed by the framework, users can provide a custom FK name by setting "keyTo". And Customer.id is keyFrom. keyFrom defaults to the id property of a model. Users can provide a custom source key name by setting "keyTo".</p> |
+|  [polymorphic?](./repository.hasonedefinition.polymorphic.md) |  | boolean \| { discriminator: string; } | <i>(Optional)</i> The polymorphism of the target model. The discriminator is a key of source model. If the target model is not polymorphic, then the value should be left undefined or false; If the key on source model indicating the concrete class of the target instance is default i.e. camelCase(classNameOf(throughModelInstance)) + "Id" Then the discriminator field can be undefined |
+|  [targetsMany](./repository.hasonedefinition.targetsmany.md) |  | false |  |
+|  [type](./repository.hasonedefinition.type.md) |  | [RelationType.hasOne](./repository.relationtype.md) |  |
 
 

package/site/apidocs/repository.hasonerepositoryfactory.md

@@ -21,8 +21,8 @@ export interface HasOneRepositoryFactory<Target extends Entity, ForeignKeyType>
 
 ## Properties
 
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [inclusionResolver](./repository.hasonerepositoryfactory.inclusionresolver.md) | [InclusionResolver](./repository.inclusionresolver.md)<!-- -->&lt;[Entity](./repository.entity.md)<!-- -->, Target&gt; | Use <code>resolver</code> property to obtain an InclusionResolver for this relation. |
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [inclusionResolver](./repository.hasonerepositoryfactory.inclusionresolver.md) |  | [InclusionResolver](./repository.inclusionresolver.md)<!-- -->&lt;[Entity](./repository.entity.md)<!-- -->, Target&gt; | Use <code>resolver</code> property to obtain an InclusionResolver for this relation. |
 
 

package/site/apidocs/repository.keyvaluerepository.md

@@ -20,7 +20,7 @@ Key/Value operations for connector implementations
 ```typescript
 export interface KeyValueRepository<T extends Model> extends Repository<T> 
 ```
-<b>Extends:</b> [Repository](./repository.repository.md)
+<b>Extends:</b> [Repository](./repository.repository.md)<!-- -->&lt;T&gt;
 
 ## Methods
 

package/site/apidocs/repository.md

@@ -30,7 +30,7 @@ This module provides data access facilities to various databases and services as
 |  [DefaultBelongsToRepository](./repository.defaultbelongstorepository.md) |  |
 |  [DefaultCrudRepository](./repository.defaultcrudrepository.md) | Default implementation of CRUD repository using legacy juggler model and data source |
 |  [DefaultHasManyRepository](./repository.defaulthasmanyrepository.md) |  |
-|  [DefaultHasManyThroughRepository](./repository.defaulthasmanythroughrepository.md) | a class for CRUD operations for hasManyThrough relation.<!-- -->Warning: The hasManyThrough interface is experimental and is subject to change. If backwards-incompatible changes are made, a new major version may not be released. |
+|  [DefaultHasManyThroughRepository](./repository.defaulthasmanythroughrepository.md) | <p>a class for CRUD operations for hasManyThrough relation.</p><p>Warning: The hasManyThrough interface is experimental and is subject to change. If backwards-incompatible changes are made, a new major version may not be released.</p> |
 |  [DefaultHasOneRepository](./repository.defaulthasonerepository.md) |  |
 |  [DefaultKeyValueRepository](./repository.defaultkeyvaluerepository.md) | An implementation of KeyValueRepository based on loopback-datasource-juggler |
 |  [DefaultReferencesManyRepository](./repository.defaultreferencesmanyrepository.md) |  |
@@ -48,7 +48,7 @@ This module provides data access facilities to various databases and services as
 |  [NumberType](./repository.numbertype.md) | Number type |
 |  [ObjectType](./repository.objecttype.md) | Object type |
 |  [RepositoryMetadata](./repository.repositorymetadata.md) | Metadata for a repository |
-|  [RepositoryMixinDoc](./repository.repositorymixindoc.md) | A dummy class created to generate the tsdoc for the members in repository mixin. Please don't use it.<!-- -->The members are implemented in function <a href="#RepositoryMixin">RepositoryMixin</a> |
+|  [RepositoryMixinDoc](./repository.repositorymixindoc.md) | <p>A dummy class created to generate the tsdoc for the members in repository mixin. Please don't use it.</p><p>The members are implemented in function <a href="#RepositoryMixin">RepositoryMixin</a></p> |
 |  [StringType](./repository.stringtype.md) | String type |
 |  [UnionType](./repository.uniontype.md) | Union type, such as string \| number |
 |  [ValueObject](./repository.valueobject.md) | Base class for value objects - An object that contains attributes but has no conceptual identity. They should be treated as immutable. |
@@ -74,19 +74,19 @@ This module provides data access facilities to various databases and services as
 |  [constrainWhere(originalWhere, constraint)](./repository.constrainwhere.md) | A utility function which takes a where filter and enforces constraint(s) on it |
 |  [constrainWhereOr(originalWhere, constraint)](./repository.constrainwhereor.md) | A utility function which takes a where filter and enforces constraint(s) on it with OR clause |
 |  [createBelongsToAccessor(belongsToMetadata, targetRepositoryGetter, sourceRepository)](./repository.createbelongstoaccessor.md) | Enforces a BelongsTo constraint on a repository If the target model is polymorphic, i.e. stored within different repositories, supply the targetRepositoryGetter with a dictionary in the form of {<!-- -->\[typeName: string\]: repositoryGetter<!-- -->} |
-|  [createBelongsToInclusionResolver(meta, getTargetRepoDict)](./repository.createbelongstoinclusionresolver.md) | Creates InclusionResolver for BelongsTo relation. Notice that this function only generates the inclusionResolver. It doesn't register it for the source repository.<!-- -->Notice: scope field for inclusion is not supported yet |
-|  [createHasManyInclusionResolver(meta, getTargetRepo)](./repository.createhasmanyinclusionresolver.md) | Creates InclusionResolver for HasMany relation. Notice that this function only generates the inclusionResolver. It doesn't register it for the source repository.<!-- -->Notice: scope field for inclusion is not supported yet. |
+|  [createBelongsToInclusionResolver(meta, getTargetRepoDict)](./repository.createbelongstoinclusionresolver.md) | <p>Creates InclusionResolver for BelongsTo relation. Notice that this function only generates the inclusionResolver. It doesn't register it for the source repository.</p><p>Notice: scope field for inclusion is not supported yet</p> |
+|  [createHasManyInclusionResolver(meta, getTargetRepo)](./repository.createhasmanyinclusionresolver.md) | <p>Creates InclusionResolver for HasMany relation. Notice that this function only generates the inclusionResolver. It doesn't register it for the source repository.</p><p>Notice: scope field for inclusion is not supported yet.</p> |
 |  [createHasManyRepositoryFactory(relationMetadata, targetRepositoryGetter)](./repository.createhasmanyrepositoryfactory.md) | Enforces a constraint on a repository based on a relationship contract between models. For example, if a Customer model is related to an Order model via a HasMany relation, then, the relational repository returned by the factory function would be constrained by a Customer model instance's id(s). |
 |  [createHasManyThroughRepositoryFactory(relationMetadata, targetRepositoryGetter, throughRepositoryGetter)](./repository.createhasmanythroughrepositoryfactory.md) |  |
-|  [createHasOneRepositoryFactory(relationMetadata, targetRepositoryGetter)](./repository.createhasonerepositoryfactory.md) | Enforces a constraint on a repository based on a relationship contract between models. For example, if a Customer model is related to an Address model via a HasOne relation, then, the relational repository returned by the factory function would be constrained by a Customer model instance's id(s).<!-- -->If the target model is polymorphic, i.e. stored within different repositories, supply the targetRepositoryGetter with a dictionary in the form of {<!-- -->\[typeName: string\]: repositoryGetter<!-- -->} |
+|  [createHasOneRepositoryFactory(relationMetadata, targetRepositoryGetter)](./repository.createhasonerepositoryfactory.md) | <p>Enforces a constraint on a repository based on a relationship contract between models. For example, if a Customer model is related to an Address model via a HasOne relation, then, the relational repository returned by the factory function would be constrained by a Customer model instance's id(s).</p><p>If the target model is polymorphic, i.e. stored within different repositories, supply the targetRepositoryGetter with a dictionary in the form of {<!-- -->\[typeName: string\]: repositoryGetter<!-- -->}</p> |
 |  [createModelClassBinding(modelClass)](./repository.createmodelclassbinding.md) | Create a binding for the given model class |
 |  [createReferencesManyAccessor(referencesManyMetadata, targetRepoGetter, sourceRepository)](./repository.createreferencesmanyaccessor.md) | Enforces a ReferencesMany constraint on a repository |
-|  [createReferencesManyInclusionResolver(meta, getTargetRepo)](./repository.createreferencesmanyinclusionresolver.md) | Creates InclusionResolver for ReferencesMany relation. Notice that this function only generates the inclusionResolver. It doesn't register it for the source repository.<!-- -->Notice: scope field for inclusion is not supported yet |
+|  [createReferencesManyInclusionResolver(meta, getTargetRepo)](./repository.createreferencesmanyinclusionresolver.md) | <p>Creates InclusionResolver for ReferencesMany relation. Notice that this function only generates the inclusionResolver. It doesn't register it for the source repository.</p><p>Notice: scope field for inclusion is not supported yet</p> |
 |  [deduplicate(input)](./repository.deduplicate.md) | Dedupe an array |
 |  [defineCrudRepositoryClass(entityClass)](./repository.definecrudrepositoryclass.md) | Create (define) an entity CRUD repository class for the given model. This function always uses <code>DefaultCrudRepository</code> as the base class, use <code>defineRepositoryClass</code> if you want to use your own base repository. |
 |  [defineKeyValueRepositoryClass(modelClass)](./repository.definekeyvaluerepositoryclass.md) | Create (define) a KeyValue repository class for the given entity. This function always uses <code>DefaultKeyValueRepository</code> as the base class, use <code>defineRepositoryClass</code> if you want to use your own base repository. |
 |  [defineModelClass(base, definition)](./repository.definemodelclass.md) | Create (define) a new model class with the given name and definition. |
-|  [defineRepositoryClass(modelClass, baseRepositoryClass)](./repository.definerepositoryclass.md) | Create (define) a repository class for the given model.<!-- -->See also <code>defineCrudRepositoryClass</code> and <code>defineKeyValueRepositoryClass</code> for convenience wrappers providing repository class factory for the default CRUD and KeyValue implementations.<!-- -->\*\*❗️IMPORTANT: The compiler (TypeScript 3.8) is not able to correctly infer generic arguments <code>M</code> and <code>R</code> from the class constructors provided in function arguments. You must always provide both M and R types explicitly.\*\* |
+|  [defineRepositoryClass(modelClass, baseRepositoryClass)](./repository.definerepositoryclass.md) | <p>Create (define) a repository class for the given model.</p><p>See also <code>defineCrudRepositoryClass</code> and <code>defineKeyValueRepositoryClass</code> for convenience wrappers providing repository class factory for the default CRUD and KeyValue implementations.</p><p>\*\*❗️IMPORTANT: The compiler (TypeScript 3.8) is not able to correctly infer generic arguments <code>M</code> and <code>R</code> from the class constructors provided in function arguments. You must always provide both M and R types explicitly.\*\*</p> |
 |  [embedsMany(definition)](./repository.embedsmany.md) | Decorator for embedsMany |
 |  [embedsOne(definition)](./repository.embedsone.md) | Decorator for embedsOne |
 |  [ensurePromise(p)](./repository.ensurepromise.md) | Ensure the value is a promise |
@@ -128,7 +128,7 @@ This module provides data access facilities to various databases and services as
 |  --- | --- |
 |  [AnyObject](./repository.anyobject.md) | Objects with open properties |
 |  [ApplicationWithRepositories](./repository.applicationwithrepositories.md) | Interface for an Application mixed in with RepositoryMixin |
-|  [BaseRepositoryClass](./repository.baserepositoryclass.md) | Signature for repository classes that can be used as the base class for <code>define*</code> functions. The constructor of a base repository class accepts the target model constructor and the datasource to use.<code>define*</code> functions require a class implementing this interface on input. |
+|  [BaseRepositoryClass](./repository.baserepositoryclass.md) | <p>Signature for repository classes that can be used as the base class for <code>define*</code> functions. The constructor of a base repository class accepts the target model constructor and the datasource to use.</p><p><code>define*</code> functions require a class implementing this interface on input.</p> |
 |  [BelongsToAccessor](./repository.belongstoaccessor.md) |  |
 |  [BelongsToDefinition](./repository.belongstodefinition.md) |  |
 |  [BelongsToRepository](./repository.belongstorepository.md) | CRUD operations for a target repository of a BelongsTo relation |
@@ -145,7 +145,7 @@ This module provides data access facilities to various databases and services as
 |  [HasManyDefinition](./repository.hasmanydefinition.md) | HasManyDefinition defines one-to-many relations and also possible defines many-to-many relations with through models. |
 |  [HasManyRepository](./repository.hasmanyrepository.md) | CRUD operations for a target repository of a HasMany relation |
 |  [HasManyRepositoryFactory](./repository.hasmanyrepositoryfactory.md) |  |
-|  [HasManyThroughRepository](./repository.hasmanythroughrepository.md) | CRUD operations for a target repository of a HasManyThrough relation<!-- -->EXPERIMENTAL: This interface is not stable and may change in the near future. Backwards-incompatible changes may be introduced in semver-minor versions. |
+|  [HasManyThroughRepository](./repository.hasmanythroughrepository.md) | <p>CRUD operations for a target repository of a HasManyThrough relation</p><p>EXPERIMENTAL: This interface is not stable and may change in the near future. Backwards-incompatible changes may be introduced in semver-minor versions.</p> |
 |  [HasOneDefinition](./repository.hasonedefinition.md) |  |
 |  [HasOneRepository](./repository.hasonerepository.md) | CRUD operations for a target repository of a HasMany relation |
 |  [HasOneRepositoryFactory](./repository.hasonerepositoryfactory.md) |  |
@@ -153,7 +153,7 @@ This module provides data access facilities to various databases and services as
 |  [KeyValueRepository](./repository.keyvaluerepository.md) | Key/Value operations for connector implementations |
 |  [KVConnector](./repository.kvconnector.md) | Key/Value operations for connector implementations |
 |  [ModelDefinitionSyntax](./repository.modeldefinitionsyntax.md) | DSL for building a model definition. |
-|  [ModelRepositoryClass](./repository.modelrepositoryclass.md) | Signature for a Repository class bound to a given model. The constructor accepts only the dataSource to use for persistence.<code>define*</code> functions return a class implementing this interface. |
+|  [ModelRepositoryClass](./repository.modelrepositoryclass.md) | <p>Signature for a Repository class bound to a given model. The constructor accepts only the dataSource to use for persistence.</p><p><code>define*</code> functions return a class implementing this interface.</p> |
 |  [ModelSettings](./repository.modelsettings.md) | Defining the settings for a model See https://loopback.io/doc/en/lb4/Model.html\#supported-entries-of-model-definition |
 |  [Persistable](./repository.persistable.md) |  |
 |  [PropertyDefinition](./repository.propertydefinition.md) | Property definition for a model |
@@ -206,10 +206,10 @@ This module provides data access facilities to various databases and services as
 |  [Constructor](./repository.constructor.md) | Constructor type - class or function |
 |  [DataObject](./repository.dataobject.md) | Type alias for strongly or weakly typed objects of T |
 |  [DeepPartial](./repository.deeppartial.md) | An extension of the built-in Partial<T> type which allows partial values in deeply nested properties too. |
-|  [DynamicModelCtor](./repository.dynamicmodelctor.md) | A type describing a model class created via <code>defineModelClass</code>.<!-- -->Assuming template arguments <code>BaseCtor</code> and <code>Props</code>, this type describes a class constructor with the following properties: - a constructor function accepting <code>DataObject&lt;Props&gt;</code> as the only argument, this argument is optional - all static fields (properties, methods) from <code>BaseCtor</code> are inherited and available as static fields on the dynamic class - all prototype fields from <code>BaseCtor</code> prototype are inherited and available as prototype fields on the dynamic class |
+|  [DynamicModelCtor](./repository.dynamicmodelctor.md) | <p>A type describing a model class created via <code>defineModelClass</code>.</p><p>Assuming template arguments <code>BaseCtor</code> and <code>Props</code>, this type describes a class constructor with the following properties: - a constructor function accepting <code>DataObject&lt;Props&gt;</code> as the only argument, this argument is optional - all static fields (properties, methods) from <code>BaseCtor</code> are inherited and available as static fields on the dynamic class - all prototype fields from <code>BaseCtor</code> prototype are inherited and available as prototype fields on the dynamic class</p> |
 |  [EntityData](./repository.entitydata.md) |  |
 |  [EntityResolver](./repository.entityresolver.md) |  |
-|  [HasManyThroughRepositoryFactory](./repository.hasmanythroughrepositoryfactory.md) | a factory to generate hasManyThrough repository class.<!-- -->Warning: The hasManyThrough interface is experimental and is subject to change. If backwards-incompatible changes are made, a new major version may not be released. |
+|  [HasManyThroughRepositoryFactory](./repository.hasmanythroughrepositoryfactory.md) | <p>a factory to generate hasManyThrough repository class.</p><p>Warning: The hasManyThrough interface is experimental and is subject to change. If backwards-incompatible changes are made, a new major version may not be released.</p> |
 |  [InclusionResolver](./repository.inclusionresolver.md) |  |
 |  [KeyValueFilter](./repository.keyvaluefilter.md) | Filter for keys |
 |  [NamedParameters](./repository.namedparameters.md) | Named parameters, such as <code>{x: 1, y: 'a'}</code> |
@@ -217,12 +217,12 @@ This module provides data access facilities to various databases and services as
 |  [PositionalParameters](./repository.positionalparameters.md) | Positional parameters, such as \[1, 'a'\] |
 |  [PropertyMap](./repository.propertymap.md) |  |
 |  [PropertyType](./repository.propertytype.md) |  |
-|  [PrototypeOf](./repository.prototypeof.md) | Type helper to infer prototype from a constructor function.<!-- -->Example: <code>PrototypeOf&lt;typeof Entity&gt;</code> is resolved to <code>Entity</code>. |
+|  [PrototypeOf](./repository.prototypeof.md) | <p>Type helper to infer prototype from a constructor function.</p><p>Example: <code>PrototypeOf&lt;typeof Entity&gt;</code> is resolved to <code>Entity</code>.</p> |
 |  [RelationDefinitionMap](./repository.relationdefinitionmap.md) | A key-value map describing model relations. A relation name is used as the key, a relation definition is the value. |
 |  [RelationMetadata](./repository.relationmetadata.md) | A union type describing all possible Relation metadata objects. |
 |  [RepositoryDecorator](./repository.repositorydecorator.md) | Type definition for decorators returned by <code>@repository</code> decorator factory |
 |  [StringKeyOf](./repository.stringkeyof.md) |  |
 |  [TransactionalEntityRepository](./repository.transactionalentityrepository.md) | A type for CRUD repositories that are backed by IDs and support Transactions |
-|  [TypeResolver](./repository.typeresolver.md) | A type resolver is a function that returns a class representing the type, typically a Model or Entity (e.g. Product).<!-- -->We use type resolvers to break require() loops when defining relations. The target model (class) is provided via a provider, thus deferring the actual reference to the class itself until later, when both sides of the relation are created as JavaScript classes. |
+|  [TypeResolver](./repository.typeresolver.md) | <p>A type resolver is a function that returns a class representing the type, typically a Model or Entity (e.g. Product).</p><p>We use type resolvers to break require() loops when defining relations. The target model (class) is provided via a provider, thus deferring the actual reference to the class itself until later, when both sides of the relation are created as JavaScript classes.</p> |
 
 

package/site/apidocs/repository.modeldefinition.md

@@ -31,7 +31,7 @@ export declare class ModelDefinition
 
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
-|  [name](./repository.modeldefinition.name.md) |  | string |  |
+|  [name](./repository.modeldefinition.name.md) | <code>readonly</code> | string |  |
 |  [properties](./repository.modeldefinition.properties.md) |  | { \[name: string\]: [PropertyDefinition](./repository.propertydefinition.md)<!-- -->; } |  |
 |  [relations](./repository.modeldefinition.relations.md) |  | [RelationDefinitionMap](./repository.relationdefinitionmap.md) |  |
 |  [settings](./repository.modeldefinition.settings.md) |  | [ModelSettings](./repository.modelsettings.md) |  |

package/site/apidocs/repository.modeldefinitionsyntax.md

@@ -23,12 +23,12 @@ export interface ModelDefinitionSyntax
 
 ## Properties
 
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [jsonSchema?](./repository.modeldefinitionsyntax.jsonschema.md) | [JsonSchemaWithExtensions](./repository.jsonschemawithextensions.md) | <i>(Optional)</i> |
-|  [name](./repository.modeldefinitionsyntax.name.md) | string |  |
-|  [properties?](./repository.modeldefinitionsyntax.properties.md) | { \[name: string\]: [PropertyDefinition](./repository.propertydefinition.md) \| [PropertyType](./repository.propertytype.md)<!-- -->; } | <i>(Optional)</i> |
-|  [relations?](./repository.modeldefinitionsyntax.relations.md) | [RelationDefinitionMap](./repository.relationdefinitionmap.md) | <i>(Optional)</i> |
-|  [settings?](./repository.modeldefinitionsyntax.settings.md) | [ModelSettings](./repository.modelsettings.md) | <i>(Optional)</i> |
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [jsonSchema?](./repository.modeldefinitionsyntax.jsonschema.md) |  | [JsonSchemaWithExtensions](./repository.jsonschemawithextensions.md) | <i>(Optional)</i> |
+|  [name](./repository.modeldefinitionsyntax.name.md) |  | string |  |
+|  [properties?](./repository.modeldefinitionsyntax.properties.md) |  | { \[name: string\]: [PropertyDefinition](./repository.propertydefinition.md) \| [PropertyType](./repository.propertytype.md)<!-- -->; } | <i>(Optional)</i> |
+|  [relations?](./repository.modeldefinitionsyntax.relations.md) |  | [RelationDefinitionMap](./repository.relationdefinitionmap.md) | <i>(Optional)</i> |
+|  [settings?](./repository.modeldefinitionsyntax.settings.md) |  | [ModelSettings](./repository.modelsettings.md) | <i>(Optional)</i> |
 
 

package/site/apidocs/repository.modelrepositoryclass.md

@@ -25,9 +25,9 @@ export interface ModelRepositoryClass<M extends Model, R extends Repository<M>>
 
 ## Properties
 
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [prototype](./repository.modelrepositoryclass.prototype.md) | R |  |
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [prototype](./repository.modelrepositoryclass.prototype.md) |  | R |  |
 
 ## Methods
 

package/site/apidocs/repository.modelsettings.md

@@ -23,12 +23,12 @@ export interface ModelSettings
 
 ## Properties
 
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [description?](./repository.modelsettings.description.md) | string | <i>(Optional)</i> Description of the model |
-|  [forceId?](./repository.modelsettings.forceid.md) | boolean | <i>(Optional)</i> Prevent clients from setting the auto-generated ID value manually |
-|  [hiddenProperties?](./repository.modelsettings.hiddenproperties.md) | string\[\] | <i>(Optional)</i> Hides properties from response bodies |
-|  [scope?](./repository.modelsettings.scope.md) | object | <i>(Optional)</i> Scope enables you to set a scope that will apply to every query made by the model's repository |
-|  [strict?](./repository.modelsettings.strict.md) | boolean \| 'filter' | <i>(Optional)</i> Specifies whether the model accepts only predefined properties or not |
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [description?](./repository.modelsettings.description.md) |  | string | <i>(Optional)</i> Description of the model |
+|  [forceId?](./repository.modelsettings.forceid.md) |  | boolean | <i>(Optional)</i> Prevent clients from setting the auto-generated ID value manually |
+|  [hiddenProperties?](./repository.modelsettings.hiddenproperties.md) |  | string\[\] | <i>(Optional)</i> Hides properties from response bodies |
+|  [scope?](./repository.modelsettings.scope.md) |  | object | <i>(Optional)</i> Scope enables you to set a scope that will apply to every query made by the model's repository |
+|  [strict?](./repository.modelsettings.strict.md) |  | boolean \| 'filter' | <i>(Optional)</i> Specifies whether the model accepts only predefined properties or not |
 
 

package/site/apidocs/repository.modeltype.md

@@ -20,7 +20,7 @@ Model type
 ```typescript
 export declare class ModelType<T extends Model> extends ObjectType<T> 
 ```
-<b>Extends:</b> [ObjectType](./repository.objecttype.md)
+<b>Extends:</b> [ObjectType](./repository.objecttype.md)<!-- -->&lt;T&gt;
 
 ## Constructors
 
@@ -33,7 +33,7 @@ export declare class ModelType<T extends Model> extends ObjectType<T>
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
 |  [modelClass](./repository.modeltype.modelclass.md) |  | [Class](./repository.class.md)<!-- -->&lt;T&gt; |  |
-|  [name](./repository.modeltype.name.md) |  | string |  |
+|  [name](./repository.modeltype.name.md) | <code>readonly</code> | string |  |
 
 ## Methods
 

package/site/apidocs/repository.nulltype.md

@@ -20,13 +20,13 @@ Null type
 ```typescript
 export declare class NullType implements Type<null> 
 ```
-<b>Implements:</b> [Type](./repository.type.md)
+<b>Implements:</b> [Type](./repository.type.md)<!-- -->&lt;null&gt;
 
 ## Properties
 
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
-|  [name](./repository.nulltype.name.md) |  | (not declared) |  |
+|  [name](./repository.nulltype.name.md) | <code>readonly</code> | (not declared) |  |
 
 ## Methods
 

package/site/apidocs/repository.numbertype.md

@@ -20,13 +20,13 @@ Number type
 ```typescript
 export declare class NumberType implements Type<number> 
 ```
-<b>Implements:</b> [Type](./repository.type.md)
+<b>Implements:</b> [Type](./repository.type.md)<!-- -->&lt;number&gt;
 
 ## Properties
 
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
-|  [name](./repository.numbertype.name.md) |  | (not declared) |  |
+|  [name](./repository.numbertype.name.md) | <code>readonly</code> | (not declared) |  |
 
 ## Methods
 

package/site/apidocs/repository.objecttype.md

@@ -20,7 +20,7 @@ Object type
 ```typescript
 export declare class ObjectType<T extends AnyObject> implements Type<T> 
 ```
-<b>Implements:</b> [Type](./repository.type.md)
+<b>Implements:</b> [Type](./repository.type.md)<!-- -->&lt;T&gt;
 
 ## Constructors
 

package/site/apidocs/repository.propertydefinition.md

@@ -23,14 +23,14 @@ export interface PropertyDefinition
 
 ## Properties
 
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [hidden?](./repository.propertydefinition.hidden.md) | boolean | <i>(Optional)</i> Used to hide this property from the response body, adding this property to the hiddenProperties array |
-|  [id?](./repository.propertydefinition.id.md) | boolean \| number | <i>(Optional)</i> |
-|  [itemType?](./repository.propertydefinition.itemtype.md) | [PropertyType](./repository.propertytype.md) | <i>(Optional)</i> |
-|  [json?](./repository.propertydefinition.json.md) | [PropertyForm](./repository.propertyform.md) | <i>(Optional)</i> |
-|  [jsonSchema?](./repository.propertydefinition.jsonschema.md) | [JsonSchemaWithExtensions](./repository.jsonschemawithextensions.md) | <i>(Optional)</i> |
-|  [store?](./repository.propertydefinition.store.md) | [PropertyForm](./repository.propertyform.md) | <i>(Optional)</i> |
-|  [type](./repository.propertydefinition.type.md) | [PropertyType](./repository.propertytype.md) |  |
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [hidden?](./repository.propertydefinition.hidden.md) |  | boolean | <i>(Optional)</i> Used to hide this property from the response body, adding this property to the hiddenProperties array |
+|  [id?](./repository.propertydefinition.id.md) |  | boolean \| number | <i>(Optional)</i> |
+|  [itemType?](./repository.propertydefinition.itemtype.md) |  | [PropertyType](./repository.propertytype.md) | <i>(Optional)</i> |
+|  [json?](./repository.propertydefinition.json.md) |  | [PropertyForm](./repository.propertyform.md) | <i>(Optional)</i> |
+|  [jsonSchema?](./repository.propertydefinition.jsonschema.md) |  | [JsonSchemaWithExtensions](./repository.jsonschemawithextensions.md) | <i>(Optional)</i> |
+|  [store?](./repository.propertydefinition.store.md) |  | [PropertyForm](./repository.propertyform.md) | <i>(Optional)</i> |
+|  [type](./repository.propertydefinition.type.md) |  | [PropertyType](./repository.propertytype.md) |  |
 
 

package/site/apidocs/repository.propertyform.md

@@ -23,10 +23,10 @@ export interface PropertyForm
 
 ## Properties
 
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [in?](./repository.propertyform.in.md) | boolean | <i>(Optional)</i> |
-|  [name?](./repository.propertyform.name.md) | string | <i>(Optional)</i> |
-|  [out?](./repository.propertyform.out.md) | boolean | <i>(Optional)</i> |
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [in?](./repository.propertyform.in.md) |  | boolean | <i>(Optional)</i> |
+|  [name?](./repository.propertyform.name.md) |  | string | <i>(Optional)</i> |
+|  [out?](./repository.propertyform.out.md) |  | boolean | <i>(Optional)</i> |
 
 

package/site/apidocs/repository.referencesmanyaccessor.md

@@ -21,8 +21,8 @@ export interface ReferencesManyAccessor<Target extends Entity, SourceId>
 
 ## Properties
 
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [inclusionResolver](./repository.referencesmanyaccessor.inclusionresolver.md) | [InclusionResolver](./repository.inclusionresolver.md)<!-- -->&lt;[Entity](./repository.entity.md)<!-- -->, Target&gt; | Use <code>resolver</code> property to obtain an InclusionResolver for this relation. |
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [inclusionResolver](./repository.referencesmanyaccessor.inclusionresolver.md) |  | [InclusionResolver](./repository.inclusionresolver.md)<!-- -->&lt;[Entity](./repository.entity.md)<!-- -->, Target&gt; | Use <code>resolver</code> property to obtain an InclusionResolver for this relation. |
 
 

package/site/apidocs/repository.referencesmanydefinition.md

@@ -22,11 +22,11 @@ export interface ReferencesManyDefinition extends RelationDefinitionBase
 
 ## Properties
 
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [keyFrom?](./repository.referencesmanydefinition.keyfrom.md) | string | <i>(Optional)</i> |
-|  [keyTo?](./repository.referencesmanydefinition.keyto.md) | string | <i>(Optional)</i> keyTo: The foreign key used by the target model for this relation. keyFrom: The source key used by the source model for this relation.<!-- -->TODO(bajtos) Add relation description. |
-|  [targetsMany](./repository.referencesmanydefinition.targetsmany.md) | true |  |
-|  [type](./repository.referencesmanydefinition.type.md) | [RelationType.referencesMany](./repository.relationtype.md) |  |
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [keyFrom?](./repository.referencesmanydefinition.keyfrom.md) |  | string | <i>(Optional)</i> |
+|  [keyTo?](./repository.referencesmanydefinition.keyto.md) |  | string | <p><i>(Optional)</i> keyTo: The foreign key used by the target model for this relation. keyFrom: The source key used by the source model for this relation.</p><p>TODO(bajtos) Add relation description.</p> |
+|  [targetsMany](./repository.referencesmanydefinition.targetsmany.md) |  | true |  |
+|  [type](./repository.referencesmanydefinition.type.md) |  | [RelationType.referencesMany](./repository.relationtype.md) |  |
 
 

package/site/apidocs/repository.relationdefinitionbase.md

@@ -21,12 +21,12 @@ export interface RelationDefinitionBase
 
 ## Properties
 
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [name](./repository.relationdefinitionbase.name.md) | string | The relation name, typically matching the name of the accessor property defined on the source model. For example "orders" or "customer". |
-|  [source](./repository.relationdefinitionbase.source.md) | typeof [Entity](./repository.entity.md) | The source model of this relation.<!-- -->E.g. when a Customer has many Order instances, then Customer is the source. |
-|  [target](./repository.relationdefinitionbase.target.md) | [TypeResolver](./repository.typeresolver.md)<!-- -->&lt;[Entity](./repository.entity.md)<!-- -->, typeof [Entity](./repository.entity.md)<!-- -->&gt; | The target model of this relation.<!-- -->E.g. when a Customer has many Order instances, then Order is the target. |
-|  [targetsMany](./repository.relationdefinitionbase.targetsmany.md) | boolean | True for relations targeting multiple instances (e.g. HasMany), false for relations with a single target (e.g. BelongsTo, HasOne). This property is needed by OpenAPI/JSON Schema generator. |
-|  [type](./repository.relationdefinitionbase.type.md) | [RelationType](./repository.relationtype.md) | The type of the relation, must be one of RelationType values. |
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [name](./repository.relationdefinitionbase.name.md) |  | string | The relation name, typically matching the name of the accessor property defined on the source model. For example "orders" or "customer". |
+|  [source](./repository.relationdefinitionbase.source.md) |  | typeof [Entity](./repository.entity.md) | <p>The source model of this relation.</p><p>E.g. when a Customer has many Order instances, then Customer is the source.</p> |
+|  [target](./repository.relationdefinitionbase.target.md) |  | [TypeResolver](./repository.typeresolver.md)<!-- -->&lt;[Entity](./repository.entity.md)<!-- -->, typeof [Entity](./repository.entity.md)<!-- -->&gt; | <p>The target model of this relation.</p><p>E.g. when a Customer has many Order instances, then Order is the target.</p> |
+|  [targetsMany](./repository.relationdefinitionbase.targetsmany.md) |  | boolean | True for relations targeting multiple instances (e.g. HasMany), false for relations with a single target (e.g. BelongsTo, HasOne). This property is needed by OpenAPI/JSON Schema generator. |
+|  [type](./repository.relationdefinitionbase.type.md) |  | [RelationType](./repository.relationtype.md) | The type of the relation, must be one of RelationType values. |
 
 

package/site/apidocs/repository.repositorycomponent.md

@@ -23,9 +23,9 @@ export interface RepositoryComponent
 
 ## Properties
 
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [models?](./repository.repositorycomponent.models.md) | [Class](./repository.class.md)<!-- -->&lt;[Model](./repository.model.md)<!-- -->&gt;\[\] | <i>(Optional)</i> An optional list of Model classes to bind for dependency injection via <code>app.model()</code> API. |
-|  [repositories?](./repository.repositorycomponent.repositories.md) | [Class](./repository.class.md)<!-- -->&lt;[Repository](./repository.repository.md)<!-- -->&lt;[Model](./repository.model.md)<!-- -->&gt;&gt;\[\] | <i>(Optional)</i> An optional list of Repository classes to bind for dependency injection via <code>app.repository()</code> API. |
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [models?](./repository.repositorycomponent.models.md) |  | [Class](./repository.class.md)<!-- -->&lt;[Model](./repository.model.md)<!-- -->&gt;\[\] | <i>(Optional)</i> An optional list of Model classes to bind for dependency injection via <code>app.model()</code> API. |
+|  [repositories?](./repository.repositorycomponent.repositories.md) |  | [Class](./repository.class.md)<!-- -->&lt;[Repository](./repository.repository.md)<!-- -->&lt;[Model](./repository.model.md)<!-- -->&gt;&gt;\[\] | <i>(Optional)</i> An optional list of Repository classes to bind for dependency injection via <code>app.repository()</code> API. |
 
 

package/site/apidocs/repository.repositorymetadata._constructor_.md

@@ -26,6 +26,6 @@ constructor(modelOrRepo: string | typeof Entity, dataSource?: string | juggler.D
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  modelOrRepo | string \| typeof [Entity](./repository.entity.md) | Name or class of the model. If the value is a string and <code>dataSource</code> is not present, it will treated as the name of a predefined repository |
-|  dataSource | string \| juggler.DataSource \| [DataSource](./repository.datasource.md) | <i>(Optional)</i> Name or instance of the data source<!-- -->For example:<!-- -->- new RepositoryMetadata(repoName); - new RepositoryMetadata(modelName, dataSourceName); - new RepositoryMetadata(modelClass, dataSourceInstance); - new RepositoryMetadata(modelName, dataSourceInstance); - new RepositoryMetadata(modelClass, dataSourceName); |
+|  dataSource | string \| juggler.DataSource \| [DataSource](./repository.datasource.md) | <p><i>(Optional)</i> Name or instance of the data source</p><p>For example:</p><p>- new RepositoryMetadata(repoName); - new RepositoryMetadata(modelName, dataSourceName); - new RepositoryMetadata(modelClass, dataSourceInstance); - new RepositoryMetadata(modelName, dataSourceInstance); - new RepositoryMetadata(modelClass, dataSourceName);</p> |
 
 

package/site/apidocs/repository.repositorymixindoc.md

@@ -36,7 +36,7 @@ export declare class RepositoryMixinDoc
 |  [component(component)](./repository.repositorymixindoc.component.md) |  | Add a component to this application. Also mounts all the components repositories. |
 |  [dataSource(dataSource, name)](./repository.repositorymixindoc.datasource.md) |  | Add the dataSource to this application. |
 |  [getRepository(repo)](./repository.repositorymixindoc.getrepository.md) |  | Retrieve the repository instance from the given Repository class |
-|  [migrateSchema(options)](./repository.repositorymixindoc.migrateschema.md) |  | Update or recreate the database schema for all repositories.<!-- -->\*\*WARNING\*\*: By default, <code>migrateSchema()</code> will attempt to preserve data while updating the schema in your target database, but this is not guaranteed to be safe.<!-- -->Please check the documentation for your specific connector(s) for a detailed breakdown of behaviors for automigrate! |
+|  [migrateSchema(options)](./repository.repositorymixindoc.migrateschema.md) |  | <p>Update or recreate the database schema for all repositories.</p><p>\*\*WARNING\*\*: By default, <code>migrateSchema()</code> will attempt to preserve data while updating the schema in your target database, but this is not guaranteed to be safe.</p><p>Please check the documentation for your specific connector(s) for a detailed breakdown of behaviors for automigrate!</p> |
 |  [mountComponentRepository(component)](./repository.repositorymixindoc.mountcomponentrepository.md) |  | Get an instance of a component and mount all it's repositories. This function is intended to be used internally by component() |
 |  [repository(repo)](./repository.repositorymixindoc.repository.md) |  | Add a repository to this application. |
 

package/site/apidocs/repository.resolvetype.md

@@ -18,7 +18,7 @@ Resolve a type value that may have been provided via TypeResolver.
 <b>Signature:</b>
 
 ```typescript
-export declare function resolveType<T extends Object>(fn: TypeResolver<T> | Class<T>): Class<T>;
+export declare function resolveType<T extends object>(fn: TypeResolver<T> | Class<T>): Class<T>;
 ```
 
 ## Parameters

package/site/apidocs/repository.schemamigrationoptions.md

@@ -22,9 +22,9 @@ export interface SchemaMigrationOptions extends Options
 
 ## Properties
 
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [existingSchema?](./repository.schemamigrationoptions.existingschema.md) | 'drop' \| 'alter' | <i>(Optional)</i> When set to 'drop', schema migration will drop existing tables and recreate them from scratch, removing any existing data along the way.<!-- -->When set to 'alter', schema migration will try to preserve current schema and data, and perform a non-destructive incremental update. |
-|  [models?](./repository.schemamigrationoptions.models.md) | string\[\] | <i>(Optional)</i> List of model names to migrate.<!-- -->By default, all models are migrated. |
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [existingSchema?](./repository.schemamigrationoptions.existingschema.md) |  | 'drop' \| 'alter' | <p><i>(Optional)</i> When set to 'drop', schema migration will drop existing tables and recreate them from scratch, removing any existing data along the way.</p><p>When set to 'alter', schema migration will try to preserve current schema and data, and perform a non-destructive incremental update.</p> |
+|  [models?](./repository.schemamigrationoptions.models.md) |  | string\[\] | <p><i>(Optional)</i> List of model names to migrate.</p><p>By default, all models are migrated.</p> |
 
 

package/site/apidocs/repository.stringtype.md

@@ -20,13 +20,13 @@ String type
 ```typescript
 export declare class StringType implements Type<string> 
 ```
-<b>Implements:</b> [Type](./repository.type.md)
+<b>Implements:</b> [Type](./repository.type.md)<!-- -->&lt;string&gt;
 
 ## Properties
 
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
-|  [name](./repository.stringtype.name.md) |  | (not declared) |  |
+|  [name](./repository.stringtype.name.md) | <code>readonly</code> | (not declared) |  |
 
 ## Methods
 

package/site/apidocs/repository.transaction.md

@@ -23,9 +23,9 @@ export interface Transaction
 
 ## Properties
 
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [id](./repository.transaction.id.md) | string | The transaction Identifier |
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [id](./repository.transaction.id.md) |  | string | The transaction Identifier |
 
 ## Methods
 

package/site/apidocs/repository.transactionalrepository.md

@@ -20,7 +20,7 @@ Repository Interface for Repositories that support Transactions
 ```typescript
 export interface TransactionalRepository<T extends Entity> extends Repository<T> 
 ```
-<b>Extends:</b> [Repository](./repository.repository.md)
+<b>Extends:</b> [Repository](./repository.repository.md)<!-- -->&lt;T&gt;
 
 ## Methods
 

package/site/apidocs/repository.type.md

@@ -21,9 +21,9 @@ export interface Type<T>
 
 ## Properties
 
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [name](./repository.type.name.md) | string | Name of the type |
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [name](./repository.type.name.md) |  | string | Name of the type |
 
 ## Methods
 

package/site/apidocs/repository.uniontype.md

@@ -20,7 +20,7 @@ Union type, such as string \| number
 ```typescript
 export declare class UnionType implements Type<any> 
 ```
-<b>Implements:</b> [Type](./repository.type.md)
+<b>Implements:</b> [Type](./repository.type.md)<!-- -->&lt;any&gt;
 
 ## Constructors
 
@@ -33,7 +33,7 @@ export declare class UnionType implements Type<any>
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
 |  [itemTypes](./repository.uniontype.itemtypes.md) |  | [Type](./repository.type.md)<!-- -->&lt;any&gt;\[\] |  |
-|  [name](./repository.uniontype.name.md) |  | (not declared) |  |
+|  [name](./repository.uniontype.name.md) | <code>readonly</code> | (not declared) |  |
 
 ## Methods
 

package/site/apidocs/rest-crud.crudrestapibuilder.md

@@ -24,7 +24,7 @@ export declare class CrudRestApiBuilder implements ModelApiBuilder
 
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
-|  [pattern](./rest-crud.crudrestapibuilder.pattern.md) |  | string |  |
+|  [pattern](./rest-crud.crudrestapibuilder.pattern.md) | <code>readonly</code> | string |  |
 
 ## Methods
 

package/site/apidocs/rest-crud.crudrestcontroller.md

@@ -23,9 +23,9 @@ export interface CrudRestController<T extends Entity, IdType, IdName extends key
 
 ## Properties
 
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [repository](./rest-crud.crudrestcontroller.repository.md) | [EntityCrudRepository](./repository.entitycrudrepository.md)<!-- -->&lt;T, IdType&gt; | The backing repository used to access &amp; modify model data. |
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [repository](./rest-crud.crudrestcontroller.repository.md) | <code>readonly</code> | [EntityCrudRepository](./repository.entitycrudrepository.md)<!-- -->&lt;T, IdType&gt; | The backing repository used to access &amp; modify model data. |
 
 ## Methods
 

package/site/apidocs/rest-crud.crudrestcontrolleroptions.md

@@ -23,9 +23,9 @@ export interface CrudRestControllerOptions
 
 ## Properties
 
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [basePath](./rest-crud.crudrestcontrolleroptions.basepath.md) | string | The base path where to "mount" the controller. |
-|  [readonly?](./rest-crud.crudrestcontrolleroptions.readonly.md) | boolean | <i>(Optional)</i> Whether to generate readonly APIs |
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [basePath](./rest-crud.crudrestcontrolleroptions.basepath.md) |  | string | The base path where to "mount" the controller. |
+|  [readonly?](./rest-crud.crudrestcontrolleroptions.readonly.md) |  | boolean | <i>(Optional)</i> Whether to generate readonly APIs |