npm - @loopback/docs - Versions diffs - 4.0.4 → 5.0.0 - Mend

@loopback/docs 4.0.4 → 5.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (628) hide show

package/site/apidocs/repository-json-schema.getwherejsonschemafor.md CHANGED Viewed

@@ -28,7 +28,7 @@ export declare function getWhereJsonSchemaFor(modelCtor: typeof Model, options?:
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  modelCtor | typeof [Model](./repository.model.md) | The model constructor to build the filter schema for. |
-|  options | [FilterSchemaOptions](./repository-json-schema.filterschemaoptions.md) |  |
+|  options | [FilterSchemaOptions](./repository-json-schema.filterschemaoptions.md) | <i>(Optional)</i> |
 <b>Returns:</b>

package/site/apidocs/repository-json-schema.modeltojsonschema.md CHANGED Viewed

@@ -28,7 +28,7 @@ export declare function modelToJsonSchema<T extends object>(ctor: Function & {
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  ctor | Function &amp; { prototype: T; } | Constructor of class to convert from |
-|  jsonSchemaOptions | [JsonSchemaOptions](./repository-json-schema.jsonschemaoptions.md)<!-- -->&lt;T&gt; |  |
+|  jsonSchemaOptions | [JsonSchemaOptions](./repository-json-schema.jsonschemaoptions.md)<!-- -->&lt;T&gt; | <i>(Optional)</i> |
 <b>Returns:</b>

package/site/apidocs/repository.anytype.md CHANGED Viewed

@@ -20,7 +20,7 @@ Any type
 ```typescript
 export declare class AnyType implements Type<any>
 ```
-<b>Implements:</b> [Type](./repository.type.md)<!-- -->&lt;any&gt;
+<b>Implements:</b> [Type](./repository.type.md)
 ## Properties

package/site/apidocs/repository.applicationwithrepositories.component.md CHANGED Viewed

@@ -24,7 +24,7 @@ component(component: Class<unknown>, name?: string): Binding;
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  component | [Class](./repository.class.md)<!-- -->&lt;unknown&gt; |  |
-|  name | string |  |
+|  name | string | <i>(Optional)</i> |
 <b>Returns:</b>

package/site/apidocs/repository.applicationwithrepositories.datasource.md CHANGED Viewed

@@ -24,7 +24,7 @@ dataSource<D extends juggler.DataSource>(dataSource: Class<D> | D, name?: string
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  dataSource | [Class](./repository.class.md)<!-- -->&lt;D&gt; \| D |  |
-|  name | string |  |
+|  name | string | <i>(Optional)</i> |
 <b>Returns:</b>

package/site/apidocs/repository.applicationwithrepositories.migrateschema.md CHANGED Viewed

@@ -23,7 +23,7 @@ migrateSchema(options?: SchemaMigrationOptions): Promise<void>;
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  options | [SchemaMigrationOptions](./repository.schemamigrationoptions.md) |  |
+|  options | [SchemaMigrationOptions](./repository.schemamigrationoptions.md) | <i>(Optional)</i> |
 <b>Returns:</b>

package/site/apidocs/repository.applicationwithrepositories.repository.md CHANGED Viewed

@@ -24,7 +24,7 @@ repository<R extends Repository<any>>(repo: Class<R>, name?: string): Binding<R>
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  repo | [Class](./repository.class.md)<!-- -->&lt;R&gt; |  |
-|  name | string |  |
+|  name | string | <i>(Optional)</i> |
 <b>Returns:</b>

package/site/apidocs/repository.arraytype.md CHANGED Viewed

@@ -20,7 +20,7 @@ Array type, such as string\[\]
 ```typescript
 export declare class ArrayType<T> implements Type<T[]>
 ```
-<b>Implements:</b> [Type](./repository.type.md)<!-- -->&lt;T\[\]&gt;
+<b>Implements:</b> [Type](./repository.type.md)
 ## Constructors

package/site/apidocs/repository.belongsto.md CHANGED Viewed

@@ -26,8 +26,8 @@ export declare function belongsTo<T extends Entity>(targetResolver: EntityResolv
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  targetResolver | [EntityResolver](./repository.entityresolver.md)<!-- -->&lt;T&gt; | A resolver function that returns the target model for a belongsTo relation |
-|  definition | Partial&lt;[BelongsToDefinition](./repository.belongstodefinition.md)<!-- -->&gt; | Optional metadata for setting up a belongsTo relation |
-|  propertyDefinition | Partial&lt;[PropertyDefinition](./repository.propertydefinition.md)<!-- -->&gt; | Optional metadata for setting up the property |
+|  definition | Partial&lt;[BelongsToDefinition](./repository.belongstodefinition.md)<!-- -->&gt; | <i>(Optional)</i> Optional metadata for setting up a belongsTo relation |
+|  propertyDefinition | Partial&lt;[PropertyDefinition](./repository.propertydefinition.md)<!-- -->&gt; | <i>(Optional)</i> Optional metadata for setting up the property |
 <b>Returns:</b>

package/site/apidocs/repository.belongstodefinition.md CHANGED Viewed

@@ -26,6 +26,7 @@ export interface BelongsToDefinition extends RelationDefinitionBase
 |  --- | --- | --- |
 |  [keyFrom?](./repository.belongstodefinition.keyfrom.md) | string | <i>(Optional)</i> |
 |  [keyTo?](./repository.belongstodefinition.keyto.md) | string | <i>(Optional)</i> |
+|  [polymorphic?](./repository.belongstodefinition.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.belongstodefinition.targetsmany.md) | false |  |
 |  [type](./repository.belongstodefinition.type.md) | [RelationType.belongsTo](./repository.relationtype.md) |  |

package/site/apidocs/repository.belongstodefinition.polymorphic.md ADDED Viewed

@@ -0,0 +1,25 @@
+---
+lang: en
+title: 'API docs: repository.belongstodefinition.polymorphic'
+keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
+sidebar: lb4_sidebar
+editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/repository
+permalink: /doc/en/lb4/apidocs.repository.belongstodefinition.polymorphic.html
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+[Home](./index.md) &gt; [@loopback/repository](./repository.md) &gt; [BelongsToDefinition](./repository.belongstodefinition.md) &gt; [polymorphic](./repository.belongstodefinition.polymorphic.md)
+## BelongsToDefinition.polymorphic property
+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
+<b>Signature:</b>
+```typescript
+polymorphic?: boolean | {
+        discriminator: string;
+    };
+```

package/site/apidocs/repository.belongstorepository.get.md CHANGED Viewed

@@ -18,14 +18,16 @@ Gets the target model instance
 <b>Signature:</b>
 ```typescript
-get(options?: Options): Promise<Target>;
+get(options?: Options & {
+        polymorphicType?: string | string[];
+    }): Promise<Target>;
 ```
 ## Parameters
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  options | [Options](./repository.options.md) |  |
+|  options | [Options](./repository.options.md) &amp; { polymorphicType?: string \| string\[\]; } | <i>(Optional)</i> options.polymorphicType - a string or a string array of polymorphic type names to specify which repositories should are expected to be searched It is highly recommended to contain this param especially for datasources using deplicated ids across tables |
 <b>Returns:</b>

package/site/apidocs/repository.booleantype.md CHANGED Viewed

@@ -20,7 +20,7 @@ Boolean type
 ```typescript
 export declare class BooleanType implements Type<boolean>
 ```
-<b>Implements:</b> [Type](./repository.type.md)<!-- -->&lt;boolean&gt;
+<b>Implements:</b> [Type](./repository.type.md)
 ## Properties

package/site/apidocs/repository.buffertype.coerce.md CHANGED Viewed

@@ -24,7 +24,7 @@ coerce(value: any, options?: Options): any;
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  value | any |  |
-|  options | [Options](./repository.options.md) |  |
+|  options | [Options](./repository.options.md) | <i>(Optional)</i> |
 <b>Returns:</b>

package/site/apidocs/repository.buffertype.md CHANGED Viewed

@@ -20,7 +20,7 @@ Buffer (binary) type
 ```typescript
 export declare class BufferType implements Type<Buffer>
 ```
-<b>Implements:</b> [Type](./repository.type.md)<!-- -->&lt;Buffer&gt;
+<b>Implements:</b> [Type](./repository.type.md)<!-- -->&lt;Buffer
 ## Properties

package/site/apidocs/repository.buffertype.serialize.md CHANGED Viewed

@@ -24,7 +24,7 @@ serialize(value: Buffer | null | undefined, options?: Options): string | null |
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  value | Buffer \| null \| undefined |  |
-|  options | [Options](./repository.options.md) |  |
+|  options | [Options](./repository.options.md) | <i>(Optional)</i> |
 <b>Returns:</b>

package/site/apidocs/repository.buildmodeldefinition.md CHANGED Viewed

@@ -28,7 +28,7 @@ export declare function buildModelDefinition(target: Function & {
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  target | Function &amp; { definition?: [ModelDefinition](./repository.modeldefinition.md) \| undefined; } | Target model class |
-|  def | [ModelDefinitionSyntax](./repository.modeldefinitionsyntax.md) | Model definition spec |
+|  def | [ModelDefinitionSyntax](./repository.modeldefinitionsyntax.md) | <i>(Optional)</i> Model definition spec |
 <b>Returns:</b>

package/site/apidocs/repository.connector.execute.md CHANGED Viewed

@@ -25,7 +25,7 @@ execute?(command: Command, parameters: NamedParameters | PositionalParameters, o
 |  --- | --- | --- |
 |  command | [Command](./repository.command.md) |  |
 |  parameters | [NamedParameters](./repository.namedparameters.md) \| [PositionalParameters](./repository.positionalparameters.md) |  |
-|  options | [Options](./repository.options.md) |  |
+|  options | [Options](./repository.options.md) | <i>(Optional)</i> |
 <b>Returns:</b>

package/site/apidocs/repository.createbelongstoaccessor.md CHANGED Viewed

@@ -13,12 +13,14 @@ permalink: /doc/en/lb4/apidocs.repository.createbelongstoaccessor.html
 ## createBelongsToAccessor() function
-Enforces a BelongsTo constraint on a repository
+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<!-- -->}
 <b>Signature:</b>
 ```typescript
-export declare function createBelongsToAccessor<Target extends Entity, TargetId, Source extends Entity, SourceId>(belongsToMetadata: BelongsToDefinition, targetRepoGetter: Getter<EntityCrudRepository<Target, TargetId>>, sourceRepository: EntityCrudRepository<Source, SourceId>): BelongsToAccessor<Target, SourceId>;
+export declare function createBelongsToAccessor<Target extends Entity, TargetId, Source extends Entity, SourceId>(belongsToMetadata: BelongsToDefinition, targetRepositoryGetter: Getter<EntityCrudRepository<Target, TargetId>> | {
+    [repoType: string]: Getter<EntityCrudRepository<Target, TargetId>>;
+}, sourceRepository: EntityCrudRepository<Source, SourceId>): BelongsToAccessor<Target, SourceId>;
 ```
 ## Parameters
@@ -26,7 +28,7 @@ export declare function createBelongsToAccessor<Target extends Entity, TargetId,
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  belongsToMetadata | [BelongsToDefinition](./repository.belongstodefinition.md) |  |
-|  targetRepoGetter | [Getter](./context.getter.md)<!-- -->&lt;[EntityCrudRepository](./repository.entitycrudrepository.md)<!-- -->&lt;Target, TargetId&gt;&gt; |  |
+|  targetRepositoryGetter | [Getter](./context.getter.md)<!-- -->&lt;[EntityCrudRepository](./repository.entitycrudrepository.md)<!-- -->&lt;Target, TargetId&gt;&gt; \| { \[repoType: string\]: [Getter](./context.getter.md)<!-- -->&lt;[EntityCrudRepository](./repository.entitycrudrepository.md)<!-- -->&lt;Target, TargetId&gt;&gt;; } |  |
 |  sourceRepository | [EntityCrudRepository](./repository.entitycrudrepository.md)<!-- -->&lt;Source, SourceId&gt; |  |
 <b>Returns:</b>

package/site/apidocs/repository.createbelongstoinclusionresolver.md CHANGED Viewed

@@ -20,7 +20,9 @@ Notice: scope field for inclusion is not supported yet
 <b>Signature:</b>
 ```typescript
-export declare function createBelongsToInclusionResolver<Target extends Entity, TargetID, TargetRelations extends object>(meta: BelongsToDefinition, getTargetRepo: Getter<EntityCrudRepository<Target, TargetID, TargetRelations>>): InclusionResolver<Entity, Target>;
+export declare function createBelongsToInclusionResolver<Target extends Entity, TargetID, TargetRelations extends object>(meta: BelongsToDefinition, getTargetRepoDict: {
+    [repoType: string]: Getter<EntityCrudRepository<Target, TargetID, TargetRelations>>;
+}): InclusionResolver<Entity, Target>;
 ```
 ## Parameters
@@ -28,7 +30,7 @@ export declare function createBelongsToInclusionResolver<Target extends Entity,
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  meta | [BelongsToDefinition](./repository.belongstodefinition.md) | resolved BelongsToMetadata |
-|  getTargetRepo | [Getter](./context.getter.md)<!-- -->&lt;[EntityCrudRepository](./repository.entitycrudrepository.md)<!-- -->&lt;Target, TargetID, TargetRelations&gt;&gt; | target repository i.e where related instances are |
+|  getTargetRepoDict | { \[repoType: string\]: [Getter](./context.getter.md)<!-- -->&lt;[EntityCrudRepository](./repository.entitycrudrepository.md)<!-- -->&lt;Target, TargetID, TargetRelations&gt;&gt;; } | dictionary of target model type - target repository i.e where related instances for different types are |
 <b>Returns:</b>

package/site/apidocs/repository.createhasmanythroughrepositoryfactory.md CHANGED Viewed

@@ -16,7 +16,9 @@ permalink: /doc/en/lb4/apidocs.repository.createhasmanythroughrepositoryfactory.
 <b>Signature:</b>
 ```typescript
-export declare function createHasManyThroughRepositoryFactory<Target extends Entity, TargetID, Through extends Entity, ThroughID, SourceID>(relationMetadata: HasManyDefinition, targetRepositoryGetter: Getter<EntityCrudRepository<Target, TargetID>>, throughRepositoryGetter: Getter<EntityCrudRepository<Through, ThroughID>>): HasManyThroughRepositoryFactory<Target, TargetID, Through, SourceID>;
+export declare function createHasManyThroughRepositoryFactory<Target extends Entity, TargetID, Through extends Entity, ThroughID, SourceID>(relationMetadata: HasManyDefinition, targetRepositoryGetter: Getter<EntityCrudRepository<Target, TargetID>> | {
+    [repoType: string]: Getter<EntityCrudRepository<Target, TargetID>>;
+}, throughRepositoryGetter: Getter<EntityCrudRepository<Through, ThroughID>>): HasManyThroughRepositoryFactory<Target, TargetID, Through, SourceID>;
 ```
 ## Parameters
@@ -24,7 +26,7 @@ export declare function createHasManyThroughRepositoryFactory<Target extends Ent
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  relationMetadata | [HasManyDefinition](./repository.hasmanydefinition.md) |  |
-|  targetRepositoryGetter | [Getter](./context.getter.md)<!-- -->&lt;[EntityCrudRepository](./repository.entitycrudrepository.md)<!-- -->&lt;Target, TargetID&gt;&gt; |  |
+|  targetRepositoryGetter | [Getter](./context.getter.md)<!-- -->&lt;[EntityCrudRepository](./repository.entitycrudrepository.md)<!-- -->&lt;Target, TargetID&gt;&gt; \| { \[repoType: string\]: [Getter](./context.getter.md)<!-- -->&lt;[EntityCrudRepository](./repository.entitycrudrepository.md)<!-- -->&lt;Target, TargetID&gt;&gt;; } |  |
 |  throughRepositoryGetter | [Getter](./context.getter.md)<!-- -->&lt;[EntityCrudRepository](./repository.entitycrudrepository.md)<!-- -->&lt;Through, ThroughID&gt;&gt; |  |
 <b>Returns:</b>

package/site/apidocs/repository.createhasonerepositoryfactory.md CHANGED Viewed

@@ -15,10 +15,14 @@ permalink: /doc/en/lb4/apidocs.repository.createhasonerepositoryfactory.html
 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<!-- -->}
 <b>Signature:</b>
 ```typescript
-export declare function createHasOneRepositoryFactory<Target extends Entity, TargetID, ForeignKeyType>(relationMetadata: HasOneDefinition, targetRepositoryGetter: Getter<EntityCrudRepository<Target, TargetID>>): HasOneRepositoryFactory<Target, ForeignKeyType>;
+export declare function createHasOneRepositoryFactory<Target extends Entity, TargetID, ForeignKeyType>(relationMetadata: HasOneDefinition, targetRepositoryGetter: Getter<EntityCrudRepository<Target, TargetID>> | {
+    [repoType: string]: Getter<EntityCrudRepository<Target, TargetID>>;
+}): HasOneRepositoryFactory<Target, ForeignKeyType>;
 ```
 ## Parameters
@@ -26,7 +30,7 @@ export declare function createHasOneRepositoryFactory<Target extends Entity, Tar
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  relationMetadata | [HasOneDefinition](./repository.hasonedefinition.md) | The relation metadata used to describe the relationship and determine how to apply the constraint. |
-|  targetRepositoryGetter | [Getter](./context.getter.md)<!-- -->&lt;[EntityCrudRepository](./repository.entitycrudrepository.md)<!-- -->&lt;Target, TargetID&gt;&gt; | The repository which represents the target model of a relation attached to a datasource. |
+|  targetRepositoryGetter | [Getter](./context.getter.md)<!-- -->&lt;[EntityCrudRepository](./repository.entitycrudrepository.md)<!-- -->&lt;Target, TargetID&gt;&gt; \| { \[repoType: string\]: [Getter](./context.getter.md)<!-- -->&lt;[EntityCrudRepository](./repository.entitycrudrepository.md)<!-- -->&lt;Target, TargetID&gt;&gt;; } | The repository or a dictionary of classname - repository, which represents the target model of a relation attached to a datasource. For the dictionary, the key is the class name of the concrete class the the polymorphic model. |
 <b>Returns:</b>

package/site/apidocs/repository.createreferencesmanyaccessor.md ADDED Viewed

@@ -0,0 +1,36 @@
+---
+lang: en
+title: 'API docs: repository.createreferencesmanyaccessor'
+keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
+sidebar: lb4_sidebar
+editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/repository
+permalink: /doc/en/lb4/apidocs.repository.createreferencesmanyaccessor.html
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+[Home](./index.md) &gt; [@loopback/repository](./repository.md) &gt; [createReferencesManyAccessor](./repository.createreferencesmanyaccessor.md)
+## createReferencesManyAccessor() function
+Enforces a ReferencesMany constraint on a repository
+<b>Signature:</b>
+```typescript
+export declare function createReferencesManyAccessor<Target extends Entity, TargetIds, Source extends Entity, SourceId>(referencesManyMetadata: ReferencesManyDefinition, targetRepoGetter: Getter<EntityCrudRepository<Target, TargetIds>>, sourceRepository: EntityCrudRepository<Source, SourceId>): ReferencesManyAccessor<Target, SourceId>;
+```
+## Parameters
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  referencesManyMetadata | [ReferencesManyDefinition](./repository.referencesmanydefinition.md) |  |
+|  targetRepoGetter | [Getter](./context.getter.md)<!-- -->&lt;[EntityCrudRepository](./repository.entitycrudrepository.md)<!-- -->&lt;Target, TargetIds&gt;&gt; |  |
+|  sourceRepository | [EntityCrudRepository](./repository.entitycrudrepository.md)<!-- -->&lt;Source, SourceId&gt; |  |
+<b>Returns:</b>
+[ReferencesManyAccessor](./repository.referencesmanyaccessor.md)<!-- -->&lt;Target, SourceId&gt;

package/site/apidocs/repository.createreferencesmanyinclusionresolver.md ADDED Viewed

@@ -0,0 +1,37 @@
+---
+lang: en
+title: 'API docs: repository.createreferencesmanyinclusionresolver'
+keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
+sidebar: lb4_sidebar
+editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/repository
+permalink: /doc/en/lb4/apidocs.repository.createreferencesmanyinclusionresolver.html
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+[Home](./index.md) &gt; [@loopback/repository](./repository.md) &gt; [createReferencesManyInclusionResolver](./repository.createreferencesmanyinclusionresolver.md)
+## createReferencesManyInclusionResolver() function
+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
+<b>Signature:</b>
+```typescript
+export declare function createReferencesManyInclusionResolver<Target extends Entity, TargetIds, TargetRelations extends object>(meta: ReferencesManyDefinition, getTargetRepo: Getter<EntityCrudRepository<Target, TargetIds, TargetRelations>>): InclusionResolver<Entity, Target>;
+```
+## Parameters
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  meta | [ReferencesManyDefinition](./repository.referencesmanydefinition.md) | resolved ReferencesManyMetadata |
+|  getTargetRepo | [Getter](./context.getter.md)<!-- -->&lt;[EntityCrudRepository](./repository.entitycrudrepository.md)<!-- -->&lt;Target, TargetIds, TargetRelations&gt;&gt; | target repository i.e where related instances are |
+<b>Returns:</b>
+[InclusionResolver](./repository.inclusionresolver.md)<!-- -->&lt;[Entity](./repository.entity.md)<!-- -->, Target&gt;

package/site/apidocs/repository.crudconnector.count.md CHANGED Viewed

@@ -26,8 +26,8 @@ count(modelClass: Class<Entity>, where?: Where<Entity>, options?: Options): Prom
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  modelClass | [Class](./repository.class.md)<!-- -->&lt;[Entity](./repository.entity.md)<!-- -->&gt; | The model class |
-|  where | [Where](./filter.where.md)<!-- -->&lt;[Entity](./repository.entity.md)<!-- -->&gt; | The matching criteria |
-|  options | [Options](./repository.options.md) | Options for the operation |
+|  where | [Where](./filter.where.md)<!-- -->&lt;[Entity](./repository.entity.md)<!-- -->&gt; | <i>(Optional)</i> The matching criteria |
+|  options | [Options](./repository.options.md) | <i>(Optional)</i> Options for the operation |
 <b>Returns:</b>

package/site/apidocs/repository.crudconnector.create.md CHANGED Viewed

@@ -27,7 +27,7 @@ create(modelClass: Class<Entity>, entity: EntityData, options?: Options): Promis
 |  --- | --- | --- |
 |  modelClass | [Class](./repository.class.md)<!-- -->&lt;[Entity](./repository.entity.md)<!-- -->&gt; | The model class |
 |  entity | [EntityData](./repository.entitydata.md) | The entity instance or data |
-|  options | [Options](./repository.options.md) | Options for the operation |
+|  options | [Options](./repository.options.md) | <i>(Optional)</i> Options for the operation |
 <b>Returns:</b>

package/site/apidocs/repository.crudconnector.createall.md CHANGED Viewed

@@ -27,7 +27,7 @@ createAll?(modelClass: Class<Entity>, entities: EntityData[], options?: Options)
 |  --- | --- | --- |
 |  modelClass | [Class](./repository.class.md)<!-- -->&lt;[Entity](./repository.entity.md)<!-- -->&gt; | The model class |
 |  entities | [EntityData](./repository.entitydata.md)<!-- -->\[\] | An array of entity instances or data |
-|  options | [Options](./repository.options.md) | Options for the operation |
+|  options | [Options](./repository.options.md) | <i>(Optional)</i> Options for the operation |
 <b>Returns:</b>

package/site/apidocs/repository.crudconnector.delete.md CHANGED Viewed

@@ -27,7 +27,7 @@ delete?(modelClass: Class<Entity>, entity: EntityData, options?: Options): Promi
 |  --- | --- | --- |
 |  modelClass | [Class](./repository.class.md)<!-- -->&lt;[Entity](./repository.entity.md)<!-- -->&gt; | The model class |
 |  entity | [EntityData](./repository.entitydata.md) | The entity instance or data |
-|  options | [Options](./repository.options.md) | Options for the operation |
+|  options | [Options](./repository.options.md) | <i>(Optional)</i> Options for the operation |
 <b>Returns:</b>

package/site/apidocs/repository.crudconnector.deleteall.md CHANGED Viewed

@@ -26,8 +26,8 @@ deleteAll(modelClass: Class<Entity>, where?: Where<Entity>, options?: Options):
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  modelClass | [Class](./repository.class.md)<!-- -->&lt;[Entity](./repository.entity.md)<!-- -->&gt; | The model class |
-|  where | [Where](./filter.where.md)<!-- -->&lt;[Entity](./repository.entity.md)<!-- -->&gt; | The matching criteria |
-|  options | [Options](./repository.options.md) | Options for the operation |
+|  where | [Where](./filter.where.md)<!-- -->&lt;[Entity](./repository.entity.md)<!-- -->&gt; | <i>(Optional)</i> The matching criteria |
+|  options | [Options](./repository.options.md) | <i>(Optional)</i> Options for the operation |
 <b>Returns:</b>

package/site/apidocs/repository.crudconnector.deletebyid.md CHANGED Viewed

@@ -27,7 +27,7 @@ deleteById?<IdType>(modelClass: Class<Entity>, id: IdType, options?: Options): P
 |  --- | --- | --- |
 |  modelClass | [Class](./repository.class.md)<!-- -->&lt;[Entity](./repository.entity.md)<!-- -->&gt; | The model class |
 |  id | IdType | The entity id value |
-|  options | [Options](./repository.options.md) | Options for the operation |
+|  options | [Options](./repository.options.md) | <i>(Optional)</i> Options for the operation |
 <b>Returns:</b>

package/site/apidocs/repository.crudconnector.exists.md CHANGED Viewed

@@ -27,7 +27,7 @@ exists?<IdType>(modelClass: Class<Entity>, id: IdType, options?: Options): Promi
 |  --- | --- | --- |
 |  modelClass | [Class](./repository.class.md)<!-- -->&lt;[Entity](./repository.entity.md)<!-- -->&gt; | The model class |
 |  id | IdType | The entity id value |
-|  options | [Options](./repository.options.md) | Options for the operation |
+|  options | [Options](./repository.options.md) | <i>(Optional)</i> Options for the operation |
 <b>Returns:</b>

package/site/apidocs/repository.crudconnector.find.md CHANGED Viewed

@@ -26,8 +26,8 @@ find(modelClass: Class<Entity>, filter?: Filter, options?: Options): Promise<Ent
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  modelClass | [Class](./repository.class.md)<!-- -->&lt;[Entity](./repository.entity.md)<!-- -->&gt; | The model class |
-|  filter | [Filter](./filter.filter.md) | The query filter |
-|  options | [Options](./repository.options.md) | Options for the operation |
+|  filter | [Filter](./filter.filter.md) | <i>(Optional)</i> The query filter |
+|  options | [Options](./repository.options.md) | <i>(Optional)</i> Options for the operation |
 <b>Returns:</b>

package/site/apidocs/repository.crudconnector.findbyid.md CHANGED Viewed

@@ -27,7 +27,7 @@ findById?<IdType>(modelClass: Class<Entity>, id: IdType, options?: Options): Pro
 |  --- | --- | --- |
 |  modelClass | [Class](./repository.class.md)<!-- -->&lt;[Entity](./repository.entity.md)<!-- -->&gt; | The model class |
 |  id | IdType | The entity id value |
-|  options | [Options](./repository.options.md) | Options for the operation |
+|  options | [Options](./repository.options.md) | <i>(Optional)</i> Options for the operation |
 <b>Returns:</b>

package/site/apidocs/repository.crudconnector.replacebyid.md CHANGED Viewed

@@ -28,7 +28,7 @@ replaceById?<IdType>(modelClass: Class<Entity>, id: IdType, data: EntityData, op
 |  modelClass | [Class](./repository.class.md)<!-- -->&lt;[Entity](./repository.entity.md)<!-- -->&gt; | The model class |
 |  id | IdType | The entity id value |
 |  data | [EntityData](./repository.entitydata.md) | The data attributes to be updated |
-|  options | [Options](./repository.options.md) | Options for the operation |
+|  options | [Options](./repository.options.md) | <i>(Optional)</i> Options for the operation |
 <b>Returns:</b>

package/site/apidocs/repository.crudconnector.save.md CHANGED Viewed

@@ -27,7 +27,7 @@ save?(modelClass: Class<Entity>, entity: EntityData, options?: Options): Promise
 |  --- | --- | --- |
 |  modelClass | [Class](./repository.class.md)<!-- -->&lt;[Entity](./repository.entity.md)<!-- -->&gt; | The model class |
 |  entity | [EntityData](./repository.entitydata.md) | The entity instance or data |
-|  options | [Options](./repository.options.md) | Options for the operation |
+|  options | [Options](./repository.options.md) | <i>(Optional)</i> Options for the operation |
 <b>Returns:</b>

package/site/apidocs/repository.crudconnector.update.md CHANGED Viewed

@@ -27,7 +27,7 @@ update?(modelClass: Class<Entity>, entity: EntityData, options?: Options): Promi
 |  --- | --- | --- |
 |  modelClass | [Class](./repository.class.md)<!-- -->&lt;[Entity](./repository.entity.md)<!-- -->&gt; | The model class |
 |  entity | [EntityData](./repository.entitydata.md) | The entity instance or data |
-|  options | [Options](./repository.options.md) | Options for the operation |
+|  options | [Options](./repository.options.md) | <i>(Optional)</i> Options for the operation |
 <b>Returns:</b>

package/site/apidocs/repository.crudconnector.updateall.md CHANGED Viewed

@@ -27,8 +27,8 @@ updateAll(modelClass: Class<Entity>, data: EntityData, where?: Where<Entity>, op
 |  --- | --- | --- |
 |  modelClass | [Class](./repository.class.md)<!-- -->&lt;[Entity](./repository.entity.md)<!-- -->&gt; | The model class |
 |  data | [EntityData](./repository.entitydata.md) | The data attributes to be updated |
-|  where | [Where](./filter.where.md)<!-- -->&lt;[Entity](./repository.entity.md)<!-- -->&gt; | The matching criteria |
-|  options | [Options](./repository.options.md) | Options for the operation |
+|  where | [Where](./filter.where.md)<!-- -->&lt;[Entity](./repository.entity.md)<!-- -->&gt; | <i>(Optional)</i> The matching criteria |
+|  options | [Options](./repository.options.md) | <i>(Optional)</i> Options for the operation |
 <b>Returns:</b>

package/site/apidocs/repository.crudconnector.updatebyid.md CHANGED Viewed

@@ -28,7 +28,7 @@ updateById?<IdType>(modelClass: Class<Entity>, id: IdType, data: EntityData, opt
 |  modelClass | [Class](./repository.class.md)<!-- -->&lt;[Entity](./repository.entity.md)<!-- -->&gt; | The model class |
 |  id | IdType | The entity id value |
 |  data | [EntityData](./repository.entitydata.md) | The data attributes to be updated |
-|  options | [Options](./repository.options.md) | Options for the operation |
+|  options | [Options](./repository.options.md) | <i>(Optional)</i> Options for the operation |
 <b>Returns:</b>

package/site/apidocs/repository.crudrepository.count.md CHANGED Viewed

@@ -25,8 +25,8 @@ count(where?: Where<T>, options?: Options): Promise<Count>;
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  where | [Where](./filter.where.md)<!-- -->&lt;T&gt; | Matching criteria |
-|  options | [Options](./repository.options.md) | Options for the operations |
+|  where | [Where](./filter.where.md)<!-- -->&lt;T&gt; | <i>(Optional)</i> Matching criteria |
+|  options | [Options](./repository.options.md) | <i>(Optional)</i> Options for the operations |
 <b>Returns:</b>

package/site/apidocs/repository.crudrepository.create.md CHANGED Viewed

@@ -26,7 +26,7 @@ create(dataObject: DataObject<T>, options?: Options): Promise<T>;
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  dataObject | [DataObject](./repository.dataobject.md)<!-- -->&lt;T&gt; | The data to be created |
-|  options | [Options](./repository.options.md) | Options for the operations |
+|  options | [Options](./repository.options.md) | <i>(Optional)</i> Options for the operations |
 <b>Returns:</b>

package/site/apidocs/repository.crudrepository.createall.md CHANGED Viewed

@@ -26,7 +26,7 @@ createAll(dataObjects: DataObject<T>[], options?: Options): Promise<T[]>;
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  dataObjects | [DataObject](./repository.dataobject.md)<!-- -->&lt;T&gt;\[\] | An array of data to be created |
-|  options | [Options](./repository.options.md) | Options for the operations |
+|  options | [Options](./repository.options.md) | <i>(Optional)</i> Options for the operations |
 <b>Returns:</b>

package/site/apidocs/repository.crudrepository.deleteall.md CHANGED Viewed

@@ -25,8 +25,8 @@ deleteAll(where?: Where<T>, options?: Options): Promise<Count>;
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  where | [Where](./filter.where.md)<!-- -->&lt;T&gt; | Matching criteria |
-|  options | [Options](./repository.options.md) | Options for the operations |
+|  where | [Where](./filter.where.md)<!-- -->&lt;T&gt; | <i>(Optional)</i> Matching criteria |
+|  options | [Options](./repository.options.md) | <i>(Optional)</i> Options for the operations |
 <b>Returns:</b>

package/site/apidocs/repository.crudrepository.find.md CHANGED Viewed

@@ -25,8 +25,8 @@ find(filter?: Filter<T>, options?: Options): Promise<(T & Relations)[]>;
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  filter | [Filter](./filter.filter.md)<!-- -->&lt;T&gt; | Query filter |
-|  options | [Options](./repository.options.md) | Options for the operations |
+|  filter | [Filter](./filter.filter.md)<!-- -->&lt;T&gt; | <i>(Optional)</i> Query filter |
+|  options | [Options](./repository.options.md) | <i>(Optional)</i> Options for the operations |
 <b>Returns:</b>

package/site/apidocs/repository.crudrepository.md CHANGED Viewed

@@ -20,7 +20,7 @@ Basic CRUD operations for ValueObject and Entity. No ID is required.
 ```typescript
 export interface CrudRepository<T extends ValueObject | Entity, Relations extends object = {}> extends Repository<T>
 ```
-<b>Extends:</b> [Repository](./repository.repository.md)<!-- -->&lt;T&gt;
+<b>Extends:</b> [Repository](./repository.repository.md)
 ## Methods