feat: add first and firstOrFail as static model methods

adonisjs · Apr 6, 2020 · 05f2422 · 05f2422
1 parent b5302d5
commit 05f2422
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 0 deletions.
diff --git a/adonis-typings/model.ts b/adonis-typings/model.ts
@@ -716,6 +716,22 @@ declare module '@ioc:Adonis/Lucid/Model' {
       options?: ModelAdapterOptions,
     ): Promise<InstanceType<T>>
 
+    /**
+     * Same as `query().first()`
+     */
+    first<T extends LucidModel> (
+      this: T,
+      options?: ModelAdapterOptions
+    ): Promise<null | InstanceType<T>>
+
+    /**
+     * Same as `query().firstOrFail()`
+     */
+    firstOrFail<T extends LucidModel> (
+      this: T,
+      options?: ModelAdapterOptions,
+    ): Promise<null | InstanceType<T>>
+
     /**
      * Find many using an array of primary keys
      */

diff --git a/src/Orm/BaseModel/index.ts b/src/Orm/BaseModel/index.ts
@@ -492,6 +492,20 @@ export class BaseModel implements LucidRow {
     return this.query(options).where(this.primaryKey, value).firstOrFail()
   }
 
+  /**
+   * Same as `query().first()`
+   */
+  public static async first (options?: ModelAdapterOptions) {
+    return this.query(options).first()
+  }
+
+  /**
+   * Same as `query().firstOrFail()`
+   */
+  public static async firstOrFail (options?: ModelAdapterOptions) {
+    return this.query(options).firstOrFail()
+  }
+
   /**
    * Find model instance using a key/value pair
    */