refactor: instance method naming convention

Author: cuebit

src/mixins/Model.ts

@@ -82,7 +82,7 @@ export default function Model(
   /**
    * Determine if the instance has been trashed.
    */
-  model.prototype.trashed = function() {
+  model.prototype.$trashed = function() {
     const { flagName } = context.createConfig(this.$self().softDeleteConfig)
 
     return this[flagName] === true

src/mixins/Query.ts

@@ -93,7 +93,7 @@ export default function Query(
   }
 
   /**
-   * Fetch all trashed records from the store
+   * Fetch all trashed records from the store.
    */
   query.prototype.allTrashed = function() {
     return this.onlyTrashed().get()
@@ -121,18 +121,18 @@ export default function Query(
     models: Data.Collection
   ) {
     return models.filter((model) => {
-      // Only trashed records.
+      // Only trashed records
       if (this.softDeletesFilter === true) {
-        return model.trashed()
+        return model.$trashed()
       }
 
-      // Include trashed records.
+      // Include trashed records
       if (this.softDeletesFilter === false) {
         return models
       }
 
-      // Exclude trashed records.
-      return !model.trashed()
+      // Exclude trashed records
+      return !model.$trashed()
     })
   })
 }

src/types/vuex-orm.ts

@@ -43,7 +43,7 @@ declare module '@vuex-orm/core' {
     /**
      * Determine if the instance has been trashed.
      */
-    trashed(): boolean
+    $trashed(): boolean
   }
 
   namespace Query {

test/feature/model/Retrieve.spec.ts

@@ -81,7 +81,7 @@ describe('Feature - Model - Retrieve', () => {
     await User.softDelete(1)
 
     const users = User.query()
-      .where((user: User) => user.trashed())
+      .where((user: User) => user.$trashed())
       .get()
 
     expect(users.length).toBe(0)
@@ -116,7 +116,7 @@ describe('Feature - Model - Retrieve', () => {
       .get()
 
     expect(users.length).toBe(2)
-    expect(users[0].trashed()).toBe(true)
-    expect(users[1].trashed()).toBe(false)
+    expect(users[0].$trashed()).toBe(true)
+    expect(users[1].$trashed()).toBe(false)
   })
 })