feat: allow default populate by id

etienne-bechara · Apr 8, 2021 · 3a7ed30 · 3a7ed30
1 parent 40cdf07
commit 3a7ed30
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 1 deletion.
diff --git a/source/orm/orm.interface/orm.service.options.ts b/source/orm/orm.interface/orm.service.options.ts
@@ -1,4 +1,5 @@
 export interface OrmServiceOptions<T> {
   uniqueKey?: string[];
   populate?: (keyof T)[] | string[];
+  populateById?: (keyof T)[] | string[];
 }
diff --git a/source/orm/orm.service.ts b/source/orm/orm.service.ts
@@ -132,10 +132,12 @@ export abstract class OrmService<Entity> {
 
   /**
    * Reads a single entity by its ID.
+   * Obeys a custom default populate different than default.
    * @param id
    * @param options
    */
   public async readById(id: string, options: OrmReadOptions<Entity> = { }): Promise<Entity> {
+    options.populate = options.populate || this.serviceOptions.populateById;
     const entity = await this.read(id, options);
 
     if (!entity[0]) {

diff --git a/source/test/company/company.service.ts b/source/test/company/company.service.ts
@@ -14,7 +14,8 @@ export class CompanyService extends OrmService<CompanyEntity> {
   ) {
     super(companyRepository, {
       uniqueKey: [ 'name' ],
-      populate: [ 'headquarter', 'branches', 'employees' ],
+      populate: [ 'employees' ],
+      populateById: [ 'headquarter', 'branches', 'employees' ],
     });
   }