fix: add nin operator to query typing and builder (#2215)

loopbackio · Jan 7, 2019 · c38bd4e · c38bd4e
1 parent 16311c5
commit c38bd4e
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 0 deletions.
diff --git a/packages/repository/src/query.ts b/packages/repository/src/query.ts
@@ -30,6 +30,7 @@ export type Operators =
   | 'lt' // <
   | 'lte' // <=
   | 'inq' // IN
+  | 'nin' // NOT IN
   | 'between' // BETWEEN [val1, val2]
   | 'exists'
   | 'and' // AND
@@ -51,6 +52,7 @@ export type PredicateComparison<PT> = {
   lt?: PT;
   lte?: PT;
   inq?: PT[];
+  nin?: PT[];
   between?: [PT, PT];
   exists?: boolean;
   like?: PT;
@@ -373,6 +375,17 @@ export class WhereBuilder<MT extends object = AnyObject> {
     return this.add(w);
   }
 
+  /**
+   * Add a `nin` condition
+   * @param key Property name
+   * @param val An array of property values
+   */
+  nin<K extends KeyOf<MT>>(key: K, val: MT[K][]): this {
+    const w: Where<MT> = {};
+    w[key] = {nin: val};
+    return this.add(w);
+  }
+
   /**
    * Add a `between` condition
    * @param key Property name

diff --git a/packages/repository/test/unit/query/query-builder.unit.ts b/packages/repository/test/unit/query/query-builder.unit.ts
@@ -44,6 +44,15 @@ describe('WhereBuilder', () => {
     expect(where).to.eql({x: {inq: [1, 2, 3]}, y: {inq: ['a', 'b']}});
   });
 
+  it('builds where object with nin', () => {
+    const whereBuilder = new WhereBuilder();
+    const where = whereBuilder
+      .nin('x', [1, 2, 3])
+      .nin('y', ['a', 'b'])
+      .build();
+    expect(where).to.eql({x: {nin: [1, 2, 3]}, y: {nin: ['a', 'b']}});
+  });
+
   it('builds where object with neq', () => {
     const whereBuilder = new WhereBuilder();
     const where = whereBuilder.neq('x', 1).build();