feat(Model): make refresh chainable

adonisjs · Jun 10, 2020 · d09e3b5 · d09e3b5
1 parent 7a518d8
commit d09e3b5
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 2 deletions.
diff --git a/adonis-typings/model.ts b/adonis-typings/model.ts
@@ -484,7 +484,7 @@ declare module '@ioc:Adonis/Lucid/Model' {
     merge (value: Partial<ModelAttributes<this>>, allowNonExtraProperties?: boolean): this
     save (): Promise<this>
     delete (): Promise<void>
-    refresh (): Promise<void>
+    refresh (): Promise<this>
     preload: ModelBuilderPreloadFn<this>
 
     /**

diff --git a/src/Orm/BaseModel/index.ts b/src/Orm/BaseModel/index.ts
@@ -1762,7 +1762,7 @@ export class BaseModel implements LucidRow {
      * Noop when model instance is not persisted
      */
     if (!this.$isPersisted) {
-      return
+      return this
     }
 
     /**
@@ -1781,5 +1781,6 @@ export class BaseModel implements LucidRow {
 
     this.fill(freshModelInstance.$attributes)
     this.$hydrateOriginals()
+    return this
   }
 }
diff --git a/test/orm/base-model.spec.ts b/test/orm/base-model.spec.ts
@@ -117,6 +117,23 @@ test.group('Base model | boot', (group) => {
     assert.instanceOf(chained, User)
   })
 
+  test('ensure refresh method is chainable', async (assert) => {
+    const adapter = new FakeAdapter()
+    class User extends BaseModel {
+      @column()
+      public username: string
+
+      @column()
+      public age: number
+    }
+    User.$adapter = adapter
+
+    const user = new User()
+    const chained = user.refresh()
+
+    assert.instanceOf(chained, User)
+  })
+
   test('compute table name from model name', async (assert) => {
     class User extends BaseModel {
       @column({ isPrimary: true })