UNPKG

@loopback/docs

Version:
38 lines (25 loc) 1.39 kB
--- lang: en title: 'API docs: repository.includerelatedmodels' keywords: LoopBack 4.0, LoopBack 4 sidebar: lb4_sidebar editurl: https://github.com/strongloop/loopback-next/tree/master/packages/repository permalink: /doc/en/lb4/apidocs.repository.includerelatedmodels.html --- <!-- Do not edit this file. It is automatically generated by API Documenter. --> [Home](./index.md) &gt; [@loopback/repository](./repository.md) &gt; [includeRelatedModels](./repository.includerelatedmodels.md) ## includeRelatedModels() function Returns model instances that include related models that have a registered resolver. <b>Signature:</b> ```typescript export declare function includeRelatedModels<T extends Entity, Relations extends object = {}>(targetRepository: EntityCrudRepository<T, unknown, Relations>, entities: T[], include?: Inclusion[], options?: Options): Promise<(T & Relations)[]>; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | | targetRepository | <code>EntityCrudRepository&lt;T, unknown, Relations&gt;</code> | The target repository where the model instances are found | | entities | <code>T[]</code> | An array of entity instances or data | | include | <code>Inclusion[]</code> | Inclusion filter | | options | <code>Options</code> | Options for the operations | <b>Returns:</b> `Promise<(T & Relations)[]>`