@loopback/docs 4.0.4 → 5.1.1

package/site/apidocs/repository.model.md

@@ -27,7 +27,7 @@ export declare function model(definition?: Partial<ModelDefinitionSyntax>): (tar
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  definition | Partial&lt;[ModelDefinitionSyntax](./repository.modeldefinitionsyntax.md)<!-- -->&gt; |  |
+|  definition | Partial&lt;[ModelDefinitionSyntax](./repository.modeldefinitionsyntax.md)<!-- -->&gt; | <i>(Optional)</i> |
 
 <b>Returns:</b>
 

package/site/apidocs/repository.model.toobject.md

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

package/site/apidocs/repository.modeldefinition.md

@@ -47,5 +47,6 @@ export declare class ModelDefinition
 |  [hasMany(name, definition)](./repository.modeldefinition.hasmany.md) |  | Define a new hasMany relation. |
 |  [hasOne(name, definition)](./repository.modeldefinition.hasone.md) |  | Define a new hasOne relation. |
 |  [idProperties()](./repository.modeldefinition.idproperties.md) |  | Get an array of names of ID properties, which are specified in the model settings or properties with <code>id</code> attribute. |
+|  [referencesMany(name, definition)](./repository.modeldefinition.referencesmany.md) |  | Define a new referencesMany relation. |
 
 

package/site/apidocs/repository.modeldefinition.referencesmany.md

@@ -0,0 +1,35 @@
+---
+lang: en
+title: 'API docs: repository.modeldefinition.referencesmany'
+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.modeldefinition.referencesmany.html
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@loopback/repository](./repository.md) &gt; [ModelDefinition](./repository.modeldefinition.md) &gt; [referencesMany](./repository.modeldefinition.referencesmany.md)
+
+## ModelDefinition.referencesMany() method
+
+Define a new referencesMany relation.
+
+<b>Signature:</b>
+
+```typescript
+referencesMany(name: string, definition: Omit<ReferencesManyDefinition, 'name' | 'type' | 'targetsMany'>): this;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  name | string | The name of the referencesMany relation. |
+|  definition | Omit&lt;[ReferencesManyDefinition](./repository.referencesmanydefinition.md)<!-- -->, 'name' \| 'type' \| 'targetsMany'&gt; | The definition of the referencesMany relation. |
+
+<b>Returns:</b>
+
+this
+
+

package/site/apidocs/repository.modelmetadatahelper.getmodelmetadata.md

@@ -26,7 +26,7 @@ static getModelMetadata(target: Function, options?: InspectionOptions): ModelDef
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  target | Function | The class from which to retrieve metadata. |
-|  options | [InspectionOptions](./metadata.inspectionoptions.md) | An options object for the MetadataInspector to customize the output of the metadata retrieval functions. |
+|  options | [InspectionOptions](./metadata.inspectionoptions.md) | <i>(Optional)</i> An options object for the MetadataInspector to customize the output of the metadata retrieval functions. |
 
 <b>Returns:</b>
 

package/site/apidocs/repository.modeltype.md

@@ -20,7 +20,7 @@ Model type
 ```typescript
 export declare class ModelType<T extends Model> extends ObjectType<T> 
 ```
-<b>Extends:</b> [ObjectType](./repository.objecttype.md)<!-- -->&lt;T&gt;
+<b>Extends:</b> [ObjectType](./repository.objecttype.md)
 
 ## Constructors
 

package/site/apidocs/repository.nulltype.md

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

package/site/apidocs/repository.numbertype.md

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

package/site/apidocs/repository.objecttype.md

@@ -20,7 +20,7 @@ Object type
 ```typescript
 export declare class ObjectType<T extends AnyObject> 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.property.array.md

@@ -24,7 +24,7 @@ function array(itemType: PropertyType, definition?: Partial<PropertyDefinition>)
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  itemType | [PropertyType](./repository.propertytype.md) | The type of array items. Examples: <code>number</code>, <code>Product</code>, <code>() =&gt; Order</code>. |
-|  definition | Partial&lt;[PropertyDefinition](./repository.propertydefinition.md)<!-- -->&gt; | Optional PropertyDefinition object for additional metadata |
+|  definition | Partial&lt;[PropertyDefinition](./repository.propertydefinition.md)<!-- -->&gt; | <i>(Optional)</i> Optional PropertyDefinition object for additional metadata |
 
 <b>Returns:</b>
 

package/site/apidocs/repository.referencesmany.md

@@ -18,18 +18,20 @@ Decorator for referencesMany
 <b>Signature:</b>
 
 ```typescript
-export declare function referencesMany(definition?: Object): PropertyDecorator;
+export declare function referencesMany<T extends Entity>(targetResolver: EntityResolver<T>, definition?: Partial<ReferencesManyDefinition>, propertyDefinition?: Partial<PropertyDefinition>): (decoratedTarget: Entity, decoratedKey: string) => void;
 ```
 
 ## Parameters
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  definition | Object |  |
+|  targetResolver | [EntityResolver](./repository.entityresolver.md)<!-- -->&lt;T&gt; | A resolver function that returns the target model for a referencesMany relation |
+|  definition | Partial&lt;[ReferencesManyDefinition](./repository.referencesmanydefinition.md)<!-- -->&gt; | <i>(Optional)</i> Optional metadata for setting up a referencesMany relation |
+|  propertyDefinition | Partial&lt;[PropertyDefinition](./repository.propertydefinition.md)<!-- -->&gt; | <i>(Optional)</i> Optional metadata for setting up the property |
 
 <b>Returns:</b>
 
-PropertyDecorator
+(decoratedTarget: [Entity](./repository.entity.md)<!-- -->, decoratedKey: string) =&gt; void
 
 A property decorator
 

package/site/apidocs/repository.referencesmanyaccessor.inclusionresolver.md

@@ -0,0 +1,23 @@
+---
+lang: en
+title: 'API docs: repository.referencesmanyaccessor.inclusionresolver'
+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.referencesmanyaccessor.inclusionresolver.html
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@loopback/repository](./repository.md) &gt; [ReferencesManyAccessor](./repository.referencesmanyaccessor.md) &gt; [inclusionResolver](./repository.referencesmanyaccessor.inclusionresolver.md)
+
+## ReferencesManyAccessor.inclusionResolver property
+
+Use `resolver` property to obtain an InclusionResolver for this relation.
+
+<b>Signature:</b>
+
+```typescript
+inclusionResolver: InclusionResolver<Entity, Target>;
+```
+

package/site/apidocs/repository.referencesmanyaccessor.md

@@ -0,0 +1,28 @@
+---
+lang: en
+title: 'API docs: repository.referencesmanyaccessor'
+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.referencesmanyaccessor.html
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@loopback/repository](./repository.md) &gt; [ReferencesManyAccessor](./repository.referencesmanyaccessor.md)
+
+## ReferencesManyAccessor interface
+
+<b>Signature:</b>
+
+```typescript
+export interface ReferencesManyAccessor<Target extends Entity, SourceId> 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [inclusionResolver](./repository.referencesmanyaccessor.inclusionresolver.md) | [InclusionResolver](./repository.inclusionresolver.md)<!-- -->&lt;[Entity](./repository.entity.md)<!-- -->, Target&gt; | Use <code>resolver</code> property to obtain an InclusionResolver for this relation. |
+
+

package/site/apidocs/repository.referencesmanydefinition.keyfrom.md

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

package/site/apidocs/repository.referencesmanydefinition.keyto.md

@@ -0,0 +1,25 @@
+---
+lang: en
+title: 'API docs: repository.referencesmanydefinition.keyto'
+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.referencesmanydefinition.keyto.html
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@loopback/repository](./repository.md) &gt; [ReferencesManyDefinition](./repository.referencesmanydefinition.md) &gt; [keyTo](./repository.referencesmanydefinition.keyto.md)
+
+## ReferencesManyDefinition.keyTo property
+
+keyTo: The foreign key used by the target model for this relation. keyFrom: The source key used by the source model for this relation.
+
+TODO(bajtos) Add relation description.
+
+<b>Signature:</b>
+
+```typescript
+keyTo?: string;
+```
+

package/site/apidocs/repository.referencesmanydefinition.md

@@ -0,0 +1,32 @@
+---
+lang: en
+title: 'API docs: repository.referencesmanydefinition'
+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.referencesmanydefinition.html
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@loopback/repository](./repository.md) &gt; [ReferencesManyDefinition](./repository.referencesmanydefinition.md)
+
+## ReferencesManyDefinition interface
+
+<b>Signature:</b>
+
+```typescript
+export interface ReferencesManyDefinition extends RelationDefinitionBase 
+```
+<b>Extends:</b> [RelationDefinitionBase](./repository.relationdefinitionbase.md)
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [keyFrom?](./repository.referencesmanydefinition.keyfrom.md) | string | <i>(Optional)</i> |
+|  [keyTo?](./repository.referencesmanydefinition.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.<!-- -->TODO(bajtos) Add relation description. |
+|  [targetsMany](./repository.referencesmanydefinition.targetsmany.md) | true |  |
+|  [type](./repository.referencesmanydefinition.type.md) | [RelationType.referencesMany](./repository.relationtype.md) |  |
+
+

package/site/apidocs/repository.referencesmanydefinition.targetsmany.md

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

package/site/apidocs/repository.referencesmanydefinition.type.md

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

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

@@ -0,0 +1,36 @@
+---
+lang: en
+title: 'API docs: repository.referencesmanyrepository.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.referencesmanyrepository.get.html
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@loopback/repository](./repository.md) &gt; [ReferencesManyRepository](./repository.referencesmanyrepository.md) &gt; [get](./repository.referencesmanyrepository.get.md)
+
+## ReferencesManyRepository.get() method
+
+Gets the target model instance
+
+<b>Signature:</b>
+
+```typescript
+get(options?: Options): Promise<Target>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  options | [Options](./repository.options.md) | <i>(Optional)</i> |
+
+<b>Returns:</b>
+
+Promise&lt;Target&gt;
+
+A promise resolved with the target object or rejected with an EntityNotFoundError when target model instance was not found.
+
+

package/site/apidocs/repository.referencesmanyrepository.md

@@ -0,0 +1,30 @@
+---
+lang: en
+title: 'API docs: repository.referencesmanyrepository'
+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.referencesmanyrepository.html
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@loopback/repository](./repository.md) &gt; [ReferencesManyRepository](./repository.referencesmanyrepository.md)
+
+## ReferencesManyRepository interface
+
+CRUD operations for a target repository of a ReferencesMany relation
+
+<b>Signature:</b>
+
+```typescript
+export interface ReferencesManyRepository<Target extends Entity> 
+```
+
+## Methods
+
+|  Method | Description |
+|  --- | --- |
+|  [get(options)](./repository.referencesmanyrepository.get.md) | Gets the target model instance |
+
+

package/site/apidocs/repository.referencesone.md

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

package/site/apidocs/repository.relation.md

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

package/site/apidocs/repository.relationmetadata.md

@@ -18,8 +18,8 @@ A union type describing all possible Relation metadata objects.
 <b>Signature:</b>
 
 ```typescript
-export declare type RelationMetadata = HasManyDefinition | BelongsToDefinition | HasOneDefinition | RelationDefinitionBase;
+export declare type RelationMetadata = HasManyDefinition | BelongsToDefinition | HasOneDefinition | ReferencesManyDefinition | RelationDefinitionBase;
 ```
-<b>References:</b> [HasManyDefinition](./repository.hasmanydefinition.md)<!-- -->, [BelongsToDefinition](./repository.belongstodefinition.md)<!-- -->, [HasOneDefinition](./repository.hasonedefinition.md)<!-- -->, [RelationDefinitionBase](./repository.relationdefinitionbase.md)
+<b>References:</b> [HasManyDefinition](./repository.hasmanydefinition.md)<!-- -->, [BelongsToDefinition](./repository.belongstodefinition.md)<!-- -->, [HasOneDefinition](./repository.hasonedefinition.md)<!-- -->, [ReferencesManyDefinition](./repository.referencesmanydefinition.md)<!-- -->, [RelationDefinitionBase](./repository.relationdefinitionbase.md)
 
 

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

@@ -26,6 +26,6 @@ constructor(modelOrRepo: string | typeof Entity, dataSource?: string | juggler.D
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  modelOrRepo | string \| typeof [Entity](./repository.entity.md) | Name or class of the model. If the value is a string and <code>dataSource</code> is not present, it will treated as the name of a predefined repository |
-|  dataSource | string \| juggler.DataSource \| [DataSource](./repository.datasource.md) | Name or instance of the data source<!-- -->For example:<!-- -->- new RepositoryMetadata(repoName); - new RepositoryMetadata(modelName, dataSourceName); - new RepositoryMetadata(modelClass, dataSourceInstance); - new RepositoryMetadata(modelName, dataSourceInstance); - new RepositoryMetadata(modelClass, dataSourceName); |
+|  dataSource | string \| juggler.DataSource \| [DataSource](./repository.datasource.md) | <i>(Optional)</i> Name or instance of the data source<!-- -->For example:<!-- -->- new RepositoryMetadata(repoName); - new RepositoryMetadata(modelName, dataSourceName); - new RepositoryMetadata(modelClass, dataSourceInstance); - new RepositoryMetadata(modelName, dataSourceInstance); - new RepositoryMetadata(modelClass, dataSourceName); |