@loopback/docs 4.0.2 → 5.0.0

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;
+    };
+```
+

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

@@ -18,7 +18,9 @@ Create a target model instance
 <b>Signature:</b>
 
 ```typescript
-create(targetModelData: DataObject<Target>, options?: Options): Promise<Target>;
+create(targetModelData: DataObject<Target>, options?: Options & {
+        polymorphicType?: string;
+    }): Promise<Target>;
 ```
 
 ## Parameters
@@ -26,7 +28,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) &amp; { polymorphicType?: string; } | <i>(Optional)</i> Options for the operation options.polymorphicType - If polymorphic target model, specify of which concrete model the created instance should be |
 
 <b>Returns:</b>
 

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

@@ -18,14 +18,16 @@ Delete the related target model instance
 <b>Signature:</b>
 
 ```typescript
-delete(options?: Options): Promise<Count>;
+delete(options?: Options & {
+        polymorphicType?: string | string[];
+    }): Promise<Count>;
 ```
 
 ## 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.hasonerepository.get.md

@@ -18,15 +18,17 @@ Find the only target model instance that belongs to the declaring model.
 <b>Signature:</b>
 
 ```typescript
-get(filter?: Pick<Filter<Target>, Exclude<keyof Filter<Target>, 'where'>>, options?: Options): Promise<Target>;
+get(filter?: Pick<Filter<Target>, Exclude<keyof Filter<Target>, 'where'>>, options?: Options & {
+        polymorphicType?: string | string[];
+    }): Promise<Target>;
 ```
 
 ## Parameters
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  filter | Pick&lt;[Filter](./filter.filter.md)<!-- -->&lt;Target&gt;, Exclude&lt;keyof [Filter](./filter.filter.md)<!-- -->&lt;Target&gt;, 'where'&gt;&gt; | Query filter without a Where condition |
-|  options | [Options](./repository.options.md) | Options for the operations |
+|  filter | Pick&lt;[Filter](./filter.filter.md)<!-- -->&lt;Target&gt;, Exclude&lt;keyof [Filter](./filter.filter.md)<!-- -->&lt;Target&gt;, 'where'&gt;&gt; | <i>(Optional)</i> Query filter without a Where condition |
+|  options | [Options](./repository.options.md) &amp; { polymorphicType?: string \| string\[\]; } | <i>(Optional)</i> Options for the operations 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.hasonerepository.patch.md

@@ -18,15 +18,19 @@ Patch the related target model instance
 <b>Signature:</b>
 
 ```typescript
-patch(dataObject: DataObject<Target>, options?: Options): Promise<Count>;
+patch(dataObject: DataObject<Target> | {
+        [polymorphicType: string]: DataObject<Target>;
+    }, options?: Options & {
+        isPolymorphic?: boolean;
+    }): Promise<Count>;
 ```
 
 ## Parameters
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  dataObject | [DataObject](./repository.dataobject.md)<!-- -->&lt;Target&gt; | The target model fields and their new values to patch |
-|  options | [Options](./repository.options.md) |  |
+|  dataObject | [DataObject](./repository.dataobject.md)<!-- -->&lt;Target&gt; \| { \[polymorphicType: string\]: [DataObject](./repository.dataobject.md)<!-- -->&lt;Target&gt;; } | The target model fields and their new values to patch If the target models are of different types, this should be a dictionary |
+|  options | [Options](./repository.options.md) &amp; { isPolymorphic?: boolean; } | <i>(Optional)</i> options.isPolymorphic - whether dataObject is a dictionary |
 
 <b>Returns:</b>
 

package/site/apidocs/repository.includefieldifnot.md

@@ -0,0 +1,33 @@
+---
+lang: en
+title: 'API docs: repository.includefieldifnot'
+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.includefieldifnot.html
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@loopback/repository](./repository.md) &gt; [includeFieldIfNot](./repository.includefieldifnot.md)
+
+## includeFieldIfNot() function
+
+<b>Signature:</b>
+
+```typescript
+export declare function includeFieldIfNot<MT>(fields: Fields<MT> | undefined, fieldToInclude: Extract<keyof MT, string>): false | Fields<MT>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  fields | [Fields](./filter.fields.md)<!-- -->&lt;MT&gt; \| undefined |  |
+|  fieldToInclude | Extract&lt;keyof MT, string&gt; |  |
+
+<b>Returns:</b>
+
+false \| [Fields](./filter.fields.md)<!-- -->&lt;MT&gt;
+
+

package/site/apidocs/repository.includerelatedmodels.md

@@ -27,8 +27,8 @@ export declare function includeRelatedModels<T extends Entity, Relations extends
 |  --- | --- | --- |
 |  targetRepository | [EntityCrudRepository](./repository.entitycrudrepository.md)<!-- -->&lt;T, unknown, Relations&gt; | The target repository where the model instances are found |
 |  entities | T\[\] | An array of entity instances or data |
-|  include | [InclusionFilter](./filter.inclusionfilter.md)<!-- -->\[\] | Inclusion filter |
-|  options | [Options](./repository.options.md) | Options for the operations |
+|  include | [InclusionFilter](./filter.inclusionfilter.md)<!-- -->\[\] | <i>(Optional)</i> Inclusion filter |
+|  options | [Options](./repository.options.md) | <i>(Optional)</i> Options for the operations |
 
 <b>Returns:</b>
 

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

@@ -0,0 +1,32 @@
+---
+lang: en
+title: 'API docs: repository.invalidpolymorphismerror._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.invalidpolymorphismerror._constructor_.html
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@loopback/repository](./repository.md) &gt; [InvalidPolymorphismError](./repository.invalidpolymorphismerror.md) &gt; [(constructor)](./repository.invalidpolymorphismerror._constructor_.md)
+
+## InvalidPolymorphismError.(constructor)
+
+Constructs a new instance of the `InvalidPolymorphismError` class
+
+<b>Signature:</b>
+
+```typescript
+constructor(typeName: string, discriminator?: string, extraProperties?: Props);
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  typeName | string |  |
+|  discriminator | string | <i>(Optional)</i> |
+|  extraProperties | Props | <i>(Optional)</i> |
+
+

package/site/apidocs/repository.invalidpolymorphismerror.code.md

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

package/site/apidocs/repository.invalidpolymorphismerror.md

@@ -0,0 +1,35 @@
+---
+lang: en
+title: 'API docs: repository.invalidpolymorphismerror'
+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.invalidpolymorphismerror.html
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@loopback/repository](./repository.md) &gt; [InvalidPolymorphismError](./repository.invalidpolymorphismerror.md)
+
+## InvalidPolymorphismError class
+
+<b>Signature:</b>
+
+```typescript
+export declare class InvalidPolymorphismError<Props extends object = {}> extends Error 
+```
+<b>Extends:</b> Error
+
+## Constructors
+
+|  Constructor | Modifiers | Description |
+|  --- | --- | --- |
+|  [(constructor)(typeName, discriminator, extraProperties)](./repository.invalidpolymorphismerror._constructor_.md) |  | Constructs a new instance of the <code>InvalidPolymorphismError</code> class |
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [code](./repository.invalidpolymorphismerror.code.md) |  | string |  |
+
+

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

@@ -27,6 +27,6 @@ constructor(reason: string, relationMeta: RelationMetadata, extraProperties?: Pr
 |  --- | --- | --- |
 |  reason | string |  |
 |  relationMeta | [RelationMetadata](./repository.relationmetadata.md) |  |
-|  extraProperties | Props |  |
+|  extraProperties | Props | <i>(Optional)</i> |
 
 

package/site/apidocs/repository.isinvalidpolymorphismerror.md

@@ -0,0 +1,32 @@
+---
+lang: en
+title: 'API docs: repository.isinvalidpolymorphismerror'
+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.isinvalidpolymorphismerror.html
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@loopback/repository](./repository.md) &gt; [isInvalidPolymorphismError](./repository.isinvalidpolymorphismerror.md)
+
+## isInvalidPolymorphismError() function
+
+<b>Signature:</b>
+
+```typescript
+export declare function isInvalidPolymorphismError(e: any): e is InvalidPolymorphismError<any>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  e | any |  |
+
+<b>Returns:</b>
+
+e is [InvalidPolymorphismError](./repository.invalidpolymorphismerror.md)<!-- -->&lt;any&gt;
+
+

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

@@ -26,7 +26,7 @@ delete(key: string, options?: Options): Promise<void>;
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  key | string | Key for the entry |
-|  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.keyvaluerepository.deleteall.md

@@ -25,7 +25,7 @@ deleteAll(options?: Options): Promise<void>;
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  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.keyvaluerepository.expire.md

@@ -27,7 +27,7 @@ expire(key: string, ttl: number, options?: Options): Promise<void>;
 |  --- | --- | --- |
 |  key | string | Key for the entry |
 |  ttl | number | Ttl for the entry |
-|  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.keyvaluerepository.get.md

@@ -26,7 +26,7 @@ get(key: string, options?: Options): Promise<T>;
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  key | string | Key for the entry |
-|  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.keyvaluerepository.keys.md

@@ -25,8 +25,8 @@ keys?(filter?: KeyValueFilter, options?: Options): AsyncIterable<string>;
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  filter | [KeyValueFilter](./repository.keyvaluefilter.md) | Filter for keys |
-|  options | [Options](./repository.options.md) | Options for the operation |
+|  filter | [KeyValueFilter](./repository.keyvaluefilter.md) | <i>(Optional)</i> Filter for keys |
+|  options | [Options](./repository.options.md) | <i>(Optional)</i> Options for the operation |
 
 <b>Returns:</b>
 

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)<!-- -->&lt;T&gt;
+<b>Extends:</b> [Repository](./repository.repository.md)
 
 ## Methods