feat: adding not-equal support

src/AbstractFirestoreRepository.ts

@@ -149,6 +149,21 @@ export abstract class AbstractFirestoreRepository<T extends IEntity> extends Bas
     return new QueryBuilder<T>(this).whereEqualTo(prop, val);
   }
 
+  /**
+   * Returns a new QueryBuilder with a filter specifying that the
+   * value in @param prop must not be equal to @param val.
+   *
+   * @param {IWherePropParam<T>} prop field to be filtered on, where
+   * prop could be keyof T or a lambda where T is the first parameter
+   * @param {IFirestoreVal} val value to compare in the filter
+   * @returns {QueryBuilder<T>} A new QueryBuilder with the specified
+   * query applied.
+   * @memberof AbstractFirestoreRepository
+   */
+  whereNotEqualTo(prop: IWherePropParam<T>, val: IFirestoreVal): IQueryBuilder<T> {
+    return new QueryBuilder<T>(this).whereNotEqualTo(prop, val);
+  }
+
   /**
    * Returns a new QueryBuilder with a filter specifying that the
    * value in @param prop must be greater than @param val.

src/BaseFirestoreRepository.spec.ts

@@ -399,6 +399,12 @@ describe('BaseFirestoreRepository', () => {
       expect(list[0].name).toEqual('Porcupine Tree');
     });
 
+    it('must filter with whereNotEqualTo', async () => {
+        const list = await bandRepository.whereNotEqualTo('name', 'Porcupine Tree').find();
+        expect(list.length).toEqual(1);
+        expect(list[0].formationYear).toEqual(1983);
+      });
+
     it('must filter with whereGreaterThan', async () => {
       const list = await bandRepository.whereGreaterThan('formationYear', 1983).find();
       expect(list.length).toEqual(1);

src/QueryBuilder.ts

@@ -32,6 +32,15 @@ export default class QueryBuilder<T extends IEntity> implements IQueryBuilder<T>
     return this;
   }
 
+  whereNotEqualTo(param: IWherePropParam<T>, val: IFirestoreVal) {
+    this.queries.push({
+      prop: this.extractWhereParam(param),
+      val,
+      operator: FirestoreOperators.notEqual,
+    });
+    return this;
+  }
+
   whereGreaterThan(prop: IWherePropParam<T>, val: IFirestoreVal) {
     this.queries.push({
       prop: this.extractWhereParam(prop),

src/types.ts

@@ -10,6 +10,7 @@ export type IFirestoreVal = string | number | Date | boolean | DocumentReference
 
 export enum FirestoreOperators {
   equal = '==',
+  notEqual = '!=',
   lessThan = '<',
   greaterThan = '>',
   lessThanEqual = '<=',
@@ -36,6 +37,7 @@ export type IWherePropParam<T> = keyof T | ((t: T) => unknown);
 
 export interface IQueryable<T extends IEntity> {
   whereEqualTo(prop: IWherePropParam<T>, val: IFirestoreVal): IQueryBuilder<T>;
+  whereNotEqualTo(prop: IWherePropParam<T>, val: IFirestoreVal): IQueryBuilder<T>;
   whereGreaterThan(prop: IWherePropParam<T>, val: IFirestoreVal): IQueryBuilder<T>;
   whereGreaterOrEqualThan(prop: IWherePropParam<T>, val: IFirestoreVal): IQueryBuilder<T>;
   whereLessThan(prop: IWherePropParam<T>, val: IFirestoreVal): IQueryBuilder<T>;