@loopback/docs 4.0.3 → 5.1.0

package/site/apidocs/repository.defaultkeyvaluerepository.ttl.md

@@ -24,7 +24,7 @@ ttl(key: string, options?: Options): Promise<number>;
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  key | string |  |
-|  options | [Options](./repository.options.md) |  |
+|  options | [Options](./repository.options.md) | <i>(Optional)</i> |
 
 <b>Returns:</b>
 

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

@@ -0,0 +1,31 @@
+---
+lang: en
+title: 'API docs: repository.defaultreferencesmanyrepository._constructor_'
+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.defaultreferencesmanyrepository._constructor_.html
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@loopback/repository](./repository.md) &gt; [DefaultReferencesManyRepository](./repository.defaultreferencesmanyrepository.md) &gt; [(constructor)](./repository.defaultreferencesmanyrepository._constructor_.md)
+
+## DefaultReferencesManyRepository.(constructor)
+
+Constructor of DefaultReferencesManyEntityCrudRepository
+
+<b>Signature:</b>
+
+```typescript
+constructor(getTargetRepository: Getter<TargetRepository>, constraint: DataObject<TargetEntity>);
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  getTargetRepository | [Getter](./context.getter.md)<!-- -->&lt;TargetRepository&gt; | the getter of the related target model repository instance |
+|  constraint | [DataObject](./repository.dataobject.md)<!-- -->&lt;TargetEntity&gt; | the key value pair representing foreign key name to constrain the target repository instance |
+
+

package/site/apidocs/repository.defaultreferencesmanyrepository.constraint.md

@@ -0,0 +1,21 @@
+---
+lang: en
+title: 'API docs: repository.defaultreferencesmanyrepository.constraint'
+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.defaultreferencesmanyrepository.constraint.html
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@loopback/repository](./repository.md) &gt; [DefaultReferencesManyRepository](./repository.defaultreferencesmanyrepository.md) &gt; [constraint](./repository.defaultreferencesmanyrepository.constraint.md)
+
+## DefaultReferencesManyRepository.constraint property
+
+<b>Signature:</b>
+
+```typescript
+constraint: DataObject<TargetEntity>;
+```
+

package/site/apidocs/repository.defaultreferencesmanyrepository.get.md

@@ -0,0 +1,32 @@
+---
+lang: en
+title: 'API docs: repository.defaultreferencesmanyrepository.get'
+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.defaultreferencesmanyrepository.get.html
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@loopback/repository](./repository.md) &gt; [DefaultReferencesManyRepository](./repository.defaultreferencesmanyrepository.md) &gt; [get](./repository.defaultreferencesmanyrepository.get.md)
+
+## DefaultReferencesManyRepository.get() method
+
+<b>Signature:</b>
+
+```typescript
+get(options?: Options): Promise<TargetEntity>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  options | [Options](./repository.options.md) | <i>(Optional)</i> |
+
+<b>Returns:</b>
+
+Promise&lt;TargetEntity&gt;
+
+

package/site/apidocs/repository.defaultreferencesmanyrepository.gettargetrepository.md

@@ -0,0 +1,21 @@
+---
+lang: en
+title: 'API docs: repository.defaultreferencesmanyrepository.gettargetrepository'
+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.defaultreferencesmanyrepository.gettargetrepository.html
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@loopback/repository](./repository.md) &gt; [DefaultReferencesManyRepository](./repository.defaultreferencesmanyrepository.md) &gt; [getTargetRepository](./repository.defaultreferencesmanyrepository.gettargetrepository.md)
+
+## DefaultReferencesManyRepository.getTargetRepository property
+
+<b>Signature:</b>
+
+```typescript
+getTargetRepository: Getter<TargetRepository>;
+```
+

package/site/apidocs/repository.defaultreferencesmanyrepository.md

@@ -0,0 +1,42 @@
+---
+lang: en
+title: 'API docs: repository.defaultreferencesmanyrepository'
+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.defaultreferencesmanyrepository.html
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@loopback/repository](./repository.md) &gt; [DefaultReferencesManyRepository](./repository.defaultreferencesmanyrepository.md)
+
+## DefaultReferencesManyRepository class
+
+<b>Signature:</b>
+
+```typescript
+export declare class DefaultReferencesManyRepository<TargetEntity extends Entity, TargetIds, TargetRepository extends EntityCrudRepository<TargetEntity, TargetIds>> implements ReferencesManyRepository<TargetEntity> 
+```
+<b>Implements:</b> [ReferencesManyRepository](./repository.referencesmanyrepository.md)
+
+## Constructors
+
+|  Constructor | Modifiers | Description |
+|  --- | --- | --- |
+|  [(constructor)(getTargetRepository, constraint)](./repository.defaultreferencesmanyrepository._constructor_.md) |  | Constructor of DefaultReferencesManyEntityCrudRepository |
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [constraint](./repository.defaultreferencesmanyrepository.constraint.md) |  | [DataObject](./repository.dataobject.md)<!-- -->&lt;TargetEntity&gt; |  |
+|  [getTargetRepository](./repository.defaultreferencesmanyrepository.gettargetrepository.md) |  | [Getter](./context.getter.md)<!-- -->&lt;TargetRepository&gt; |  |
+
+## Methods
+
+|  Method | Modifiers | Description |
+|  --- | --- | --- |
+|  [get(options)](./repository.defaultreferencesmanyrepository.get.md) |  |  |
+
+

package/site/apidocs/repository.defaulttransactionalrepository.begintransaction.md

@@ -23,7 +23,7 @@ beginTransaction(options?: IsolationLevel | Options): Promise<Transaction>;
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  options | [IsolationLevel](./repository.isolationlevel.md) \| [Options](./repository.options.md) |  |
+|  options | [IsolationLevel](./repository.isolationlevel.md) \| [Options](./repository.options.md) | <i>(Optional)</i> |
 
 <b>Returns:</b>
 

package/site/apidocs/repository.defaulttransactionalrepository.md

@@ -20,9 +20,9 @@ Default implementation of CRUD repository using legacy juggler model and data so
 ```typescript
 export declare class DefaultTransactionalRepository<T extends Entity, ID, Relations extends object = {}> extends DefaultCrudRepository<T, ID, Relations> implements TransactionalEntityRepository<T, ID, Relations> 
 ```
-<b>Extends:</b> [DefaultCrudRepository](./repository.defaultcrudrepository.md)<!-- -->&lt;T, ID, Relations&gt;
+<b>Extends:</b> [DefaultCrudRepository](./repository.defaultcrudrepository.md)
 
-<b>Implements:</b> [TransactionalEntityRepository](./repository.transactionalentityrepository.md)<!-- -->&lt;T, ID, Relations&gt;
+<b>Implements:</b> [TransactionalEntityRepository](./repository.transactionalentityrepository.md)
 
 ## Methods
 

package/site/apidocs/repository.embedsmany.md

@@ -25,7 +25,7 @@ export declare function embedsMany(definition?: Object): PropertyDecorator;
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  definition | Object |  |
+|  definition | Object | <i>(Optional)</i> |
 
 <b>Returns:</b>
 

package/site/apidocs/repository.embedsone.md

@@ -25,7 +25,7 @@ export declare function embedsOne(definition?: Object): PropertyDecorator;
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  definition | Object |  |
+|  definition | Object | <i>(Optional)</i> |
 
 <b>Returns:</b>
 

package/site/apidocs/repository.entitycrudrepository.delete.md

@@ -26,7 +26,7 @@ delete(entity: DataObject<T>, options?: Options): Promise<void>;
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  entity | [DataObject](./repository.dataobject.md)<!-- -->&lt;T&gt; | Entity to be deleted |
-|  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.entitycrudrepository.deletebyid.md

@@ -26,7 +26,7 @@ deleteById(id: ID, options?: Options): Promise<void>;
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  id | ID | Value for the entity id |
-|  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.entitycrudrepository.exists.md

@@ -26,7 +26,7 @@ exists(id: ID, options?: Options): Promise<boolean>;
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  id | ID | Value for the entity id |
-|  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.entitycrudrepository.findbyid.md

@@ -26,8 +26,8 @@ findById(id: ID, filter?: FilterExcludingWhere<T>, options?: Options): Promise<T
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  id | ID | Value for the entity id |
-|  filter | [FilterExcludingWhere](./filter.filterexcludingwhere.md)<!-- -->&lt;T&gt; | Additional query options. E.g. <code>filter.include</code> configures which related models to fetch as part of the database query (or queries). |
-|  options | [Options](./repository.options.md) | Options for the operations |
+|  filter | [FilterExcludingWhere](./filter.filterexcludingwhere.md)<!-- -->&lt;T&gt; | <i>(Optional)</i> Additional query options. E.g. <code>filter.include</code> configures which related models to fetch as part of the database query (or queries). |
+|  options | [Options](./repository.options.md) | <i>(Optional)</i> Options for the operations |
 
 <b>Returns:</b>
 

package/site/apidocs/repository.entitycrudrepository.md

@@ -20,7 +20,7 @@ CRUD operations for a repository of entities
 ```typescript
 export interface EntityCrudRepository<T extends Entity, ID, Relations extends object = {}> extends EntityRepository<T, ID>, CrudRepository<T, Relations> 
 ```
-<b>Extends:</b> [EntityRepository](./repository.entityrepository.md)<!-- -->&lt;T, ID&gt;, [CrudRepository](./repository.crudrepository.md)<!-- -->&lt;T, Relations&gt;
+<b>Extends:</b> [EntityRepository](./repository.entityrepository.md)<!-- -->&lt;T, ID&gt;, [CrudRepository](./repository.crudrepository.md)
 
 ## Properties
 

package/site/apidocs/repository.entitycrudrepository.replacebyid.md

@@ -27,7 +27,7 @@ replaceById(id: ID, data: DataObject<T>, options?: Options): Promise<void>;
 |  --- | --- | --- |
 |  id | ID | Value for the entity id |
 |  data | [DataObject](./repository.dataobject.md)<!-- -->&lt;T&gt; | Data attributes to be replaced |
-|  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.entitycrudrepository.save.md

@@ -26,7 +26,7 @@ save(entity: DataObject<T>, options?: Options): Promise<T>;
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  entity | [DataObject](./repository.dataobject.md)<!-- -->&lt;T&gt; | Entity to be saved |
-|  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.entitycrudrepository.update.md

@@ -26,7 +26,7 @@ update(entity: DataObject<T>, options?: Options): Promise<void>;
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  entity | [DataObject](./repository.dataobject.md)<!-- -->&lt;T&gt; | Entity to be updated |
-|  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.entitycrudrepository.updatebyid.md

@@ -27,7 +27,7 @@ updateById(id: ID, data: DataObject<T>, options?: Options): Promise<void>;
 |  --- | --- | --- |
 |  id | ID | Value for the entity id |
 |  data | [DataObject](./repository.dataobject.md)<!-- -->&lt;T&gt; | Data attributes to be updated |
-|  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.entitynotfounderror._constructor_.md

@@ -27,6 +27,6 @@ constructor(entityOrName: typeof Entity | string, entityId: ID, extraProperties?
 |  --- | --- | --- |
 |  entityOrName | typeof [Entity](./repository.entity.md) \| string |  |
 |  entityId | ID |  |
-|  extraProperties | Props |  |
+|  extraProperties | Props | <i>(Optional)</i> |
 
 

package/site/apidocs/repository.entityrepository.md

@@ -20,6 +20,6 @@ Base interface for a repository of entities
 ```typescript
 export interface EntityRepository<T extends Entity, ID> extends ExecutableRepository<T> 
 ```
-<b>Extends:</b> [ExecutableRepository](./repository.executablerepository.md)<!-- -->&lt;T&gt;
+<b>Extends:</b> [ExecutableRepository](./repository.executablerepository.md)
 
 

package/site/apidocs/repository.executablerepository.execute.md

@@ -27,7 +27,7 @@ execute(command: Command, parameters: NamedParameters | PositionalParameters, op
 |  --- | --- | --- |
 |  command | [Command](./repository.command.md) | The query string or command object |
 |  parameters | [NamedParameters](./repository.namedparameters.md) \| [PositionalParameters](./repository.positionalparameters.md) | The object with name/value pairs or an array of parameter values |
-|  options | [Options](./repository.options.md) | Options |
+|  options | [Options](./repository.options.md) | <i>(Optional)</i> Options |
 
 <b>Returns:</b>
 

package/site/apidocs/repository.executablerepository.md

@@ -18,7 +18,7 @@ permalink: /doc/en/lb4/apidocs.repository.executablerepository.html
 ```typescript
 export interface ExecutableRepository<T extends Model> extends Repository<T> 
 ```
-<b>Extends:</b> [Repository](./repository.repository.md)<!-- -->&lt;T&gt;
+<b>Extends:</b> [Repository](./repository.repository.md)
 
 ## Methods
 

package/site/apidocs/repository.findbyforeignkeys.md

@@ -30,8 +30,8 @@ export declare function findByForeignKeys<Target extends Entity, TargetRelations
 |  targetRepository | [EntityCrudRepository](./repository.entitycrudrepository.md)<!-- -->&lt;Target, unknown, TargetRelations&gt; | The target repository where the related model instances are found |
 |  fkName | ForeignKey | Name of the foreign key |
 |  fkValues | Target\[ForeignKey\]\[\] \| Target\[ForeignKey\] | One value or array of values of the foreign key to be included |
-|  scope | [Filter](./filter.filter.md)<!-- -->&lt;Target&gt; &amp; { totalLimit?: number; } | Additional scope constraints |
-|  options | [Options](./repository.options.md) | Options for the operations |
+|  scope | [Filter](./filter.filter.md)<!-- -->&lt;Target&gt; &amp; { totalLimit?: number; } | <i>(Optional)</i> Additional scope constraints |
+|  options | [Options](./repository.options.md) | <i>(Optional)</i> Options for the operations |
 
 <b>Returns:</b>
 

package/site/apidocs/repository.hasmany.md

@@ -26,7 +26,7 @@ export declare function hasMany<T extends Entity>(targetResolver: EntityResolver
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  targetResolver | [EntityResolver](./repository.entityresolver.md)<!-- -->&lt;T&gt; | Target model for hasMany relation |
-|  definition | Partial&lt;[HasManyDefinition](./repository.hasmanydefinition.md)<!-- -->&gt; | Optional metadata for setting up hasMany relation |
+|  definition | Partial&lt;[HasManyDefinition](./repository.hasmanydefinition.md)<!-- -->&gt; | <i>(Optional)</i> Optional metadata for setting up hasMany relation |
 
 <b>Returns:</b>
 

package/site/apidocs/repository.hasmanydefinition.md

@@ -29,7 +29,7 @@ export interface HasManyDefinition extends RelationDefinitionBase
 |  [keyFrom?](./repository.hasmanydefinition.keyfrom.md) | string | <i>(Optional)</i> |
 |  [keyTo?](./repository.hasmanydefinition.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 many Order instances, 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". |
 |  [targetsMany](./repository.hasmanydefinition.targetsmany.md) | true |  |
-|  [through?](./repository.hasmanydefinition.through.md) | { model: [TypeResolver](./repository.typeresolver.md)<!-- -->&lt;[Entity](./repository.entity.md)<!-- -->, typeof [Entity](./repository.entity.md)<!-- -->&gt;; keyFrom?: string; keyTo?: string; } | <i>(Optional)</i> Description of the through model of the hasManyThrough relation.<!-- -->A <code>hasManyThrough</code> relation defines a many-to-many connection with another model. This relation indicates that the declaring model can be matched with zero or more instances of another model by proceeding through a third model.<!-- -->E.g a Category has many Products, and a Product can have many Categories. CategoryProductLink can be the through model. Such a through model has information of foreign keys of the source model(Category) and the target model(Product).<!-- -->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. |
+|  [through?](./repository.hasmanydefinition.through.md) | { model: [TypeResolver](./repository.typeresolver.md)<!-- -->&lt;[Entity](./repository.entity.md)<!-- -->, typeof [Entity](./repository.entity.md)<!-- -->&gt;; keyFrom?: string; keyTo?: string; polymorphic?: boolean \| { discriminator: string; }; } | <i>(Optional)</i> Description of the through model of the hasManyThrough relation.<!-- -->A <code>hasManyThrough</code> relation defines a many-to-many connection with another model. This relation indicates that the declaring model can be matched with zero or more instances of another model by proceeding through a third model.<!-- -->E.g a Category has many Products, and a Product can have many Categories. CategoryProductLink can be the through model. Such a through model has information of foreign keys of the source model(Category) and the target model(Product).<!-- -->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. |
 |  [type](./repository.hasmanydefinition.type.md) | [RelationType.hasMany](./repository.relationtype.md) |  |
 
 

package/site/apidocs/repository.hasmanydefinition.through.md

@@ -28,6 +28,9 @@ through?: {
         model: TypeResolver<Entity, typeof Entity>;
         keyFrom?: string;
         keyTo?: string;
+        polymorphic?: boolean | {
+            discriminator: string;
+        };
     };
 ```
 

package/site/apidocs/repository.hasmanyrepository.create.md

@@ -26,7 +26,7 @@ create(targetModelData: DataObject<Target>, options?: Options): Promise<Target>;
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  targetModelData | [DataObject](./repository.dataobject.md)<!-- -->&lt;Target&gt; | The target model 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.hasmanyrepository.delete.md

@@ -25,8 +25,8 @@ delete(where?: Where<Target>, options?: Options): Promise<Count>;
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  where | [Where](./filter.where.md)<!-- -->&lt;Target&gt; | Instances within the where scope are deleted |
-|  options | [Options](./repository.options.md) |  |
+|  where | [Where](./filter.where.md)<!-- -->&lt;Target&gt; | <i>(Optional)</i> Instances within the where scope are deleted |
+|  options | [Options](./repository.options.md) | <i>(Optional)</i> |
 
 <b>Returns:</b>
 

package/site/apidocs/repository.hasmanyrepository.find.md

@@ -25,8 +25,8 @@ find(filter?: Filter<Target>, options?: Options): Promise<Target[]>;
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  filter | [Filter](./filter.filter.md)<!-- -->&lt;Target&gt; | A filter object for where, order, limit, etc. |
-|  options | [Options](./repository.options.md) | Options for the operation |
+|  filter | [Filter](./filter.filter.md)<!-- -->&lt;Target&gt; | <i>(Optional)</i> A filter object for where, order, limit, etc. |
+|  options | [Options](./repository.options.md) | <i>(Optional)</i> Options for the operation |
 
 <b>Returns:</b>
 

package/site/apidocs/repository.hasmanyrepository.patch.md

@@ -26,8 +26,8 @@ patch(dataObject: DataObject<Target>, where?: Where<Target>, options?: Options):
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  dataObject | [DataObject](./repository.dataobject.md)<!-- -->&lt;Target&gt; | The fields and their new values to patch |
-|  where | [Where](./filter.where.md)<!-- -->&lt;Target&gt; | Instances within the where scope are patched |
-|  options | [Options](./repository.options.md) |  |
+|  where | [Where](./filter.where.md)<!-- -->&lt;Target&gt; | <i>(Optional)</i> Instances within the where scope are patched |
+|  options | [Options](./repository.options.md) | <i>(Optional)</i> |
 
 <b>Returns:</b>
 

package/site/apidocs/repository.hasmanythroughrepository.create.md

@@ -21,6 +21,8 @@ Create a target model instance
 create(targetModelData: DataObject<Target>, options?: Options & {
         throughData?: DataObject<Through>;
         throughOptions?: Options;
+    } & {
+        polymorphicType?: string;
     }): Promise<Target>;
 ```
 
@@ -29,7 +31,7 @@ create(targetModelData: DataObject<Target>, options?: Options & {
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  targetModelData | [DataObject](./repository.dataobject.md)<!-- -->&lt;Target&gt; | The target model data |
-|  options | [Options](./repository.options.md) &amp; { throughData?: [DataObject](./repository.dataobject.md)<!-- -->&lt;Through&gt;; throughOptions?: [Options](./repository.options.md)<!-- -->; } | Options for the operation |
+|  options | [Options](./repository.options.md) &amp; { throughData?: [DataObject](./repository.dataobject.md)<!-- -->&lt;Through&gt;; throughOptions?: [Options](./repository.options.md)<!-- -->; } &amp; { polymorphicType?: string; } | <i>(Optional)</i> Options for the operation options.polymorphicType a string or a string array of polymorphic type names specify of which concrete model the created instance should be |
 
 <b>Returns:</b>
 

package/site/apidocs/repository.hasmanythroughrepository.delete.md

@@ -19,7 +19,11 @@ Delete multiple target model instances
 
 ```typescript
 delete(where?: Where<Target>, options?: Options & {
-        throughOptions?: Options;
+        throughOptions?: Options & {
+            discriminator?: string;
+        };
+    } & {
+        polymorphicType?: string | string[];
     }): Promise<Count>;
 ```
 
@@ -27,8 +31,8 @@ delete(where?: Where<Target>, options?: Options & {
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  where | [Where](./filter.where.md)<!-- -->&lt;Target&gt; | Instances within the where scope are deleted |
-|  options | [Options](./repository.options.md) &amp; { throughOptions?: [Options](./repository.options.md)<!-- -->; } |  |
+|  where | [Where](./filter.where.md)<!-- -->&lt;Target&gt; | <i>(Optional)</i> Instances within the where scope are deleted |
+|  options | [Options](./repository.options.md) &amp; { throughOptions?: [Options](./repository.options.md) &amp; { discriminator?: string; }; } &amp; { polymorphicType?: string \| string\[\]; } | <i>(Optional)</i> options.throughOptions.discriminator - target discriminator field on through 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.hasmanythroughrepository.find.md

@@ -19,7 +19,11 @@ Find target model instance(s)
 
 ```typescript
 find(filter?: Filter<Target>, options?: Options & {
-        throughOptions?: Options;
+        throughOptions?: Options & {
+            discriminator?: string;
+        };
+    } & {
+        polymorphicType?: string | string[];
     }): Promise<Target[]>;
 ```
 
@@ -27,8 +31,8 @@ find(filter?: Filter<Target>, options?: Options & {
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  filter | [Filter](./filter.filter.md)<!-- -->&lt;Target&gt; | A filter object for where, order, limit, etc. |
-|  options | [Options](./repository.options.md) &amp; { throughOptions?: [Options](./repository.options.md)<!-- -->; } | Options for the operation |
+|  filter | [Filter](./filter.filter.md)<!-- -->&lt;Target&gt; | <i>(Optional)</i> A filter object for where, order, limit, etc. |
+|  options | [Options](./repository.options.md) &amp; { throughOptions?: [Options](./repository.options.md) &amp; { discriminator?: string; }; } &amp; { polymorphicType?: string \| string\[\]; } | <i>(Optional)</i> Options for the operation options.throughOptions.discriminator - target discriminator field on through 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.hasmanythroughrepository.link.md

@@ -29,7 +29,7 @@ link(targetModelId: TargetID, options?: Options & {
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  targetModelId | TargetID | The target model ID to link |
-|  options | [Options](./repository.options.md) &amp; { throughData?: [DataObject](./repository.dataobject.md)<!-- -->&lt;Through&gt;; throughOptions?: [Options](./repository.options.md)<!-- -->; } |  |
+|  options | [Options](./repository.options.md) &amp; { throughData?: [DataObject](./repository.dataobject.md)<!-- -->&lt;Through&gt;; throughOptions?: [Options](./repository.options.md)<!-- -->; } | <i>(Optional)</i> |
 
 <b>Returns:</b>
 

package/site/apidocs/repository.hasmanythroughrepository.patch.md

@@ -18,8 +18,14 @@ Patch multiple target model instances
 <b>Signature:</b>
 
 ```typescript
-patch(dataObject: DataObject<Target>, where?: Where<Target>, options?: Options & {
-        throughOptions?: Options;
+patch(dataObject: DataObject<Target> | {
+        [polymorphicType: string]: DataObject<Target>;
+    }, where?: Where<Target>, options?: Options & {
+        throughOptions?: Options & {
+            discriminator?: string;
+        };
+    } & {
+        isPolymorphic?: boolean;
     }): Promise<Count>;
 ```
 
@@ -27,9 +33,9 @@ patch(dataObject: DataObject<Target>, where?: Where<Target>, options?: Options &
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  dataObject | [DataObject](./repository.dataobject.md)<!-- -->&lt;Target&gt; | The fields and their new values to patch |
-|  where | [Where](./filter.where.md)<!-- -->&lt;Target&gt; | Instances within the where scope are patched |
-|  options | [Options](./repository.options.md) &amp; { throughOptions?: [Options](./repository.options.md)<!-- -->; } |  |
+|  dataObject | [DataObject](./repository.dataobject.md)<!-- -->&lt;Target&gt; \| { \[polymorphicType: string\]: [DataObject](./repository.dataobject.md)<!-- -->&lt;Target&gt;; } | The fields and their new values to patch |
+|  where | [Where](./filter.where.md)<!-- -->&lt;Target&gt; | <i>(Optional)</i> Instances within the where scope are patched |
+|  options | [Options](./repository.options.md) &amp; { throughOptions?: [Options](./repository.options.md) &amp; { discriminator?: string; }; } &amp; { isPolymorphic?: boolean; } | <i>(Optional)</i> options.throughOptions.discriminator - target discriminator field on through options.isPolymorphic - whether dataObject is a dictionary |
 
 <b>Returns:</b>
 

package/site/apidocs/repository.hasmanythroughrepository.unlink.md

@@ -28,7 +28,7 @@ unlink(targetModelId: TargetID, options?: Options & {
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  targetModelId | TargetID | The target model to unlink |
-|  options | [Options](./repository.options.md) &amp; { throughOptions?: [Options](./repository.options.md)<!-- -->; } |  |
+|  options | [Options](./repository.options.md) &amp; { throughOptions?: [Options](./repository.options.md)<!-- -->; } | <i>(Optional)</i> |
 
 <b>Returns:</b>
 

package/site/apidocs/repository.hasmanythroughrepository.unlinkall.md

@@ -27,7 +27,7 @@ unlinkAll(options?: Options & {
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  options | [Options](./repository.options.md) &amp; { throughOptions?: [Options](./repository.options.md)<!-- -->; } |  A promise which resolves to void |
+|  options | [Options](./repository.options.md) &amp; { throughOptions?: [Options](./repository.options.md)<!-- -->; } | <i>(Optional)</i>  A promise which resolves to void |
 
 <b>Returns:</b>
 

package/site/apidocs/repository.hasone.md

@@ -24,7 +24,7 @@ export declare function hasOne<T extends Entity>(targetResolver: EntityResolver<
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  targetResolver | [EntityResolver](./repository.entityresolver.md)<!-- -->&lt;T&gt; |  |
-|  definition | Partial&lt;[HasOneDefinition](./repository.hasonedefinition.md)<!-- -->&gt; |  |
+|  definition | Partial&lt;[HasOneDefinition](./repository.hasonedefinition.md)<!-- -->&gt; | <i>(Optional)</i> |
 
 <b>Returns:</b>
 

package/site/apidocs/repository.hasonedefinition.md

@@ -26,6 +26,7 @@ export interface HasOneDefinition extends RelationDefinitionBase
 |  --- | --- | --- |
 |  [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) |  |
 

package/site/apidocs/repository.hasonedefinition.polymorphic.md

@@ -0,0 +1,25 @@
+---
+lang: en
+title: 'API docs: repository.hasonedefinition.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.hasonedefinition.polymorphic.html
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@loopback/repository](./repository.md) &gt; [HasOneDefinition](./repository.hasonedefinition.md) &gt; [polymorphic](./repository.hasonedefinition.polymorphic.md)
+
+## HasOneDefinition.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;
+    };
+```
+