@loopback/docs
Version:
Documentation for LoopBack 4
37 lines (24 loc) • 1.31 kB
Markdown
---
lang: en
title: 'API docs: repository.includerelatedmodels'
keywords: LoopBack 4.0, LoopBack 4
sidebar: lb4_sidebar
permalink: /doc/en/lb4/apidocs.repository.includerelatedmodels.html
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) > [@loopback/repository](./repository.md) > [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<T>[], options?: Options): Promise<(T & Relations)[]>;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| targetRepository | <code>EntityCrudRepository<T, unknown, Relations></code> | The target repository where the model instances are found |
| entities | <code>T[]</code> | An array of entity instances or data |
| include | <code>Inclusion<T>[]</code> | Inclusion filter |
| options | <code>Options</code> | Options for the operations |
<b>Returns:</b>
`Promise<(T & Relations)[]>`