npm - @loopback/docs - Versions diffs - 4.0.2 → 5.0.0 - Mend

@loopback/docs 4.0.2 → 5.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (632) hide show

package/site/apidocs/repository.defaulthasmanythroughrepository.throughresolver.md ADDED Viewed

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

package/site/apidocs/repository.defaulthasmanythroughrepository.unlink.md CHANGED Viewed

@@ -26,7 +26,7 @@ unlink(targetId: TargetID, options?: Options & {
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  targetId | TargetID |  |
-|  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.defaulthasmanythroughrepository.unlinkall.md CHANGED Viewed

@@ -25,7 +25,7 @@ unlinkAll(options?: Options & {
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  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.defaulthasonerepository._constructor_.md CHANGED Viewed

@@ -18,14 +18,17 @@ Constructor of DefaultHasOneEntityCrudRepository
 <b>Signature:</b>
 ```typescript
-constructor(getTargetRepository: Getter<TargetRepository>, constraint: DataObject<TargetEntity>);
+constructor(getTargetRepository: Getter<TargetRepository> | {
+        [repoType: string]: Getter<TargetRepository>;
+    }, constraint: DataObject<TargetEntity>, targetResolver: TypeResolver<Entity, typeof Entity>);
 ```
 ## Parameters
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  getTargetRepository | [Getter](./context.getter.md)<!-- -->&lt;TargetRepository&gt; | the getter of the related target model repository instance |
+|  getTargetRepository | [Getter](./context.getter.md)<!-- -->&lt;TargetRepository&gt; \| { \[repoType: string\]: [Getter](./context.getter.md)<!-- -->&lt;TargetRepository&gt;; } | either a dictionary of target model type - target repository instance or a single target repository instance e.g. if the target is of a non-polymorphic type "Student", put the studentRepositoryGetterInstance if the target is of a polymorphic type "Person" which can be either a "Student" or a "Teacher" then put "<!-- -->{<!-- -->Student: studentRepositoryGetterInstance, Teacher: teacherRepositoryGetterInstance<!-- -->}<!-- -->" |
 |  constraint | [DataObject](./repository.dataobject.md)<!-- -->&lt;TargetEntity&gt; | the key value pair representing foreign key name to constrain the target repository instance |
+|  targetResolver | [TypeResolver](./repository.typeresolver.md)<!-- -->&lt;[Entity](./repository.entity.md)<!-- -->, typeof [Entity](./repository.entity.md)<!-- -->&gt; | () =<!-- -->&gt; Target to resolve the target class e.g. if the target is of type "Student", then put "() =<!-- -->&gt; Student" |

package/site/apidocs/repository.defaulthasonerepository.create.md CHANGED Viewed

@@ -16,7 +16,9 @@ permalink: /doc/en/lb4/apidocs.repository.defaulthasonerepository.create.html
 <b>Signature:</b>
 ```typescript
-create(targetModelData: DataObject<TargetEntity>, options?: Options): Promise<TargetEntity>;
+create(targetModelData: DataObject<TargetEntity>, options?: Options & {
+        polymorphicType?: string;
+    }): Promise<TargetEntity>;
 ```
 ## Parameters
@@ -24,7 +26,7 @@ create(targetModelData: DataObject<TargetEntity>, options?: Options): Promise<Ta
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  targetModelData | [DataObject](./repository.dataobject.md)<!-- -->&lt;TargetEntity&gt; |  |
-|  options | [Options](./repository.options.md) |  |
+|  options | [Options](./repository.options.md) &amp; { polymorphicType?: string; } | <i>(Optional)</i> |
 <b>Returns:</b>

package/site/apidocs/repository.defaulthasonerepository.delete.md CHANGED Viewed

@@ -16,14 +16,16 @@ permalink: /doc/en/lb4/apidocs.repository.defaulthasonerepository.delete.html
 <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> |
 <b>Returns:</b>

package/site/apidocs/repository.defaulthasonerepository.get.md CHANGED Viewed

@@ -16,15 +16,17 @@ permalink: /doc/en/lb4/apidocs.repository.defaulthasonerepository.get.html
 <b>Signature:</b>
 ```typescript
-get(filter?: Pick<Filter<TargetEntity>, Exclude<keyof Filter<TargetEntity>, 'where'>>, options?: Options): Promise<TargetEntity>;
+get(filter?: Pick<Filter<TargetEntity>, Exclude<keyof Filter<TargetEntity>, 'where'>>, options?: Options & {
+        polymorphicType?: string | string[];
+    }): Promise<TargetEntity>;
 ```
 ## Parameters
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  filter | Pick&lt;[Filter](./filter.filter.md)<!-- -->&lt;TargetEntity&gt;, Exclude&lt;keyof [Filter](./filter.filter.md)<!-- -->&lt;TargetEntity&gt;, 'where'&gt;&gt; |  |
-|  options | [Options](./repository.options.md) |  |
+|  filter | Pick&lt;[Filter](./filter.filter.md)<!-- -->&lt;TargetEntity&gt;, Exclude&lt;keyof [Filter](./filter.filter.md)<!-- -->&lt;TargetEntity&gt;, 'where'&gt;&gt; | <i>(Optional)</i> |
+|  options | [Options](./repository.options.md) &amp; { polymorphicType?: string \| string\[\]; } | <i>(Optional)</i> |
 <b>Returns:</b>

package/site/apidocs/repository.defaulthasonerepository.gettargetrepository.md CHANGED Viewed

@@ -16,6 +16,8 @@ permalink: /doc/en/lb4/apidocs.repository.defaulthasonerepository.gettargetrepos
 <b>Signature:</b>
 ```typescript
-getTargetRepository: Getter<TargetRepository>;
+getTargetRepository: Getter<TargetRepository> | {
+        [repoType: string]: Getter<TargetRepository>;
+    };
 ```

package/site/apidocs/repository.defaulthasonerepository.gettargetrepositorydict.md ADDED Viewed

@@ -0,0 +1,23 @@
+---
+lang: en
+title: 'API docs: repository.defaulthasonerepository.gettargetrepositorydict'
+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.defaulthasonerepository.gettargetrepositorydict.html
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+[Home](./index.md) &gt; [@loopback/repository](./repository.md) &gt; [DefaultHasOneRepository](./repository.defaulthasonerepository.md) &gt; [getTargetRepositoryDict](./repository.defaulthasonerepository.gettargetrepositorydict.md)
+## DefaultHasOneRepository.getTargetRepositoryDict property
+<b>Signature:</b>
+```typescript
+getTargetRepositoryDict: {
+        [repoType: string]: Getter<TargetRepository>;
+    };
+```

package/site/apidocs/repository.defaulthasonerepository.md CHANGED Viewed

@@ -18,20 +18,22 @@ permalink: /doc/en/lb4/apidocs.repository.defaulthasonerepository.html
 ```typescript
 export declare class DefaultHasOneRepository<TargetEntity extends Entity, TargetID, TargetRepository extends EntityCrudRepository<TargetEntity, TargetID>> implements HasOneRepository<TargetEntity>
 ```
-<b>Implements:</b> [HasOneRepository](./repository.hasonerepository.md)<!-- -->&lt;TargetEntity&gt;
+<b>Implements:</b> [HasOneRepository](./repository.hasonerepository.md)
 ## Constructors
 |  Constructor | Modifiers | Description |
 |  --- | --- | --- |
-|  [(constructor)(getTargetRepository, constraint)](./repository.defaulthasonerepository._constructor_.md) |  | Constructor of DefaultHasOneEntityCrudRepository |
+|  [(constructor)(getTargetRepository, constraint, targetResolver)](./repository.defaulthasonerepository._constructor_.md) |  | Constructor of DefaultHasOneEntityCrudRepository |
 ## Properties
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
 |  [constraint](./repository.defaulthasonerepository.constraint.md) |  | [DataObject](./repository.dataobject.md)<!-- -->&lt;TargetEntity&gt; |  |
-|  [getTargetRepository](./repository.defaulthasonerepository.gettargetrepository.md) |  | [Getter](./context.getter.md)<!-- -->&lt;TargetRepository&gt; |  |
+|  [getTargetRepository](./repository.defaulthasonerepository.gettargetrepository.md) |  | [Getter](./context.getter.md)<!-- -->&lt;TargetRepository&gt; \| { \[repoType: string\]: [Getter](./context.getter.md)<!-- -->&lt;TargetRepository&gt;; } |  |
+|  [getTargetRepositoryDict](./repository.defaulthasonerepository.gettargetrepositorydict.md) |  | { \[repoType: string\]: [Getter](./context.getter.md)<!-- -->&lt;TargetRepository&gt;; } |  |
+|  [targetResolver](./repository.defaulthasonerepository.targetresolver.md) |  | [TypeResolver](./repository.typeresolver.md)<!-- -->&lt;[Entity](./repository.entity.md)<!-- -->, typeof [Entity](./repository.entity.md)<!-- -->&gt; |  |
 ## Methods

package/site/apidocs/repository.defaulthasonerepository.patch.md CHANGED Viewed

@@ -16,15 +16,19 @@ permalink: /doc/en/lb4/apidocs.repository.defaulthasonerepository.patch.html
 <b>Signature:</b>
 ```typescript
-patch(dataObject: DataObject<TargetEntity>, options?: Options): Promise<Count>;
+patch(dataObject: DataObject<TargetEntity> | {
+        [polymorphicType: string]: DataObject<TargetEntity>;
+    }, options?: Options & {
+        isPolymorphic?: boolean;
+    }): Promise<Count>;
 ```
 ## Parameters
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  dataObject | [DataObject](./repository.dataobject.md)<!-- -->&lt;TargetEntity&gt; |  |
-|  options | [Options](./repository.options.md) |  |
+|  dataObject | [DataObject](./repository.dataobject.md)<!-- -->&lt;TargetEntity&gt; \| { \[polymorphicType: string\]: [DataObject](./repository.dataobject.md)<!-- -->&lt;TargetEntity&gt;; } |  |
+|  options | [Options](./repository.options.md) &amp; { isPolymorphic?: boolean; } | <i>(Optional)</i> |
 <b>Returns:</b>

package/site/apidocs/repository.defaulthasonerepository.targetresolver.md ADDED Viewed

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

package/site/apidocs/repository.defaultkeyvaluerepository.delete.md CHANGED Viewed

@@ -24,7 +24,7 @@ delete(key: string, options?: Options): Promise<void>;
 |  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.defaultkeyvaluerepository.deleteall.md CHANGED Viewed

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

package/site/apidocs/repository.defaultkeyvaluerepository.expire.md CHANGED Viewed

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

package/site/apidocs/repository.defaultkeyvaluerepository.get.md CHANGED Viewed

@@ -24,7 +24,7 @@ get(key: string, options?: Options): Promise<T>;
 |  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.defaultkeyvaluerepository.keys.md CHANGED Viewed

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

package/site/apidocs/repository.defaultkeyvaluerepository.md CHANGED Viewed

@@ -20,7 +20,7 @@ An implementation of KeyValueRepository based on loopback-datasource-juggler
 ```typescript
 export declare class DefaultKeyValueRepository<T extends Model> implements KeyValueRepository<T>
 ```
-<b>Implements:</b> [KeyValueRepository](./repository.keyvaluerepository.md)<!-- -->&lt;T&gt;
+<b>Implements:</b> [KeyValueRepository](./repository.keyvaluerepository.md)
 ## Constructors

package/site/apidocs/repository.defaultkeyvaluerepository.set.md CHANGED Viewed

@@ -25,7 +25,7 @@ set(key: string, value: DataObject<T>, options?: Options): Promise<void>;
 |  --- | --- | --- |
 |  key | string |  |
 |  value | [DataObject](./repository.dataobject.md)<!-- -->&lt;T&gt; |  |
-|  options | [Options](./repository.options.md) |  |
+|  options | [Options](./repository.options.md) | <i>(Optional)</i> |
 <b>Returns:</b>

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

@@ -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 ADDED Viewed

@@ -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 ADDED Viewed

@@ -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 ADDED Viewed

@@ -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 ADDED Viewed

@@ -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 ADDED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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)