Add skipFields

Author: phortx

src/interfaces.ts

@@ -32,6 +32,7 @@ export interface ORMModel {
   name: string;
   entity: string;
   eagerLoad: undefined | Array<string>;
+  skipFields: undefined | Array<string>;
 
   fields (): any;
   dispatch (name: string, ...params: Array<any>): any;

src/model.ts

@@ -42,12 +42,15 @@ export default class Model {
   }
 
   /**
-   * Tells if a field should be ignored. This is true for fields that start with a `$` and all foreign keys
+   * Tells if a field should be ignored. This is true for fields that start with a `$` or is it is within the skipField
+   * property.
+   *
    * @param {string} field
    * @returns {boolean}
    */
   public skipField (field: string) {
     if (field.startsWith('$')) return true;
+    if (this.baseModel.skipFields && this.baseModel.skipFields.indexOf(field) >= 0) return true;
 
     let shouldSkipField: boolean = false;
 

test/integration/VuexORMApollo.spec.js

@@ -20,6 +20,7 @@ class User extends ORMModel {
 class Video extends ORMModel {
   static entity = 'videos';
   static eagerLoad = ['comments'];
+  static skipFields = ['ignoreMe'];
 
   static fields () {
     return {
@@ -28,6 +29,7 @@ class Video extends ORMModel {
       title: this.string(''),
       userId: this.number(0),
       otherId: this.number(0), // This is a field which ends with `Id` but doesn't belong to any relation
+      ignoreMe: this.string(''),
       user: this.belongsTo(User, 'userId'),
       comments: this.morphMany(Comment, 'subjectId', 'subjectType')
     };