fix: support skip query arg

NFTX-project · Oct 18, 2024 · c4db0f1 · c4db0f1
1 parent 5c3f129
commit c4db0f1
Show file tree

Hide file tree

Showing 4 changed files with 22 additions and 1 deletion.
diff --git a/packages/query/src/createQuery/createQuery.ts b/packages/query/src/createQuery/createQuery.ts
@@ -32,6 +32,7 @@ const createQueryObj = (args: {
   name: string;
   alias?: string;
   first?: number;
+  skip?: number;
   orderBy?: string;
   orderDirection?: string;
   where?: WhereStatements;
@@ -45,6 +46,12 @@ const createQueryObj = (args: {
         first: limit,
       });
     },
+    skip: (limit: number) => {
+      return createQueryObj({
+        ...args,
+        skip: limit,
+      });
+    },
     orderBy: (field: any) => {
       return createQueryObj({ ...args, orderBy: field });
     },

diff --git a/packages/query/src/createQuery/queryTypes.ts b/packages/query/src/createQuery/queryTypes.ts
@@ -34,6 +34,7 @@ type QuerySingle<QName extends Index<QDef>, QDef> = {
 
 type QueryList<QName extends Index<QDef>, QDef extends Array<any>> = {
   first(limit: number): Query<QName, QDef>;
+  skip(limit: number): Query<QName, QDef>;
   orderBy<K extends keyof QDef[0]>(field: K): Query<QName, QDef>;
   orderDirection(direction: 'asc' | 'desc'): Query<QName, QDef>;
 } & QueryCommon<QName, QDef, QDef[0]>;

diff --git a/packages/query/src/createQuery/stringifyQuery.ts b/packages/query/src/createQuery/stringifyQuery.ts
@@ -8,6 +8,7 @@ const stringifyQuery = (args: {
   name: string;
   alias?: string;
   first?: number;
+  skip?: number;
   orderBy?: string;
   orderDirection?: string;
   where?: WhereStatements;
@@ -27,11 +28,21 @@ const stringifyQuery = (args: {
   output.push(args.name, ' ');
   const w = args.where && stringifyWhere(args.where);
   // Filters
-  if (args.first || args.orderBy || args.orderDirection || w || args.id) {
+  if (
+    args.first ||
+    args.skip ||
+    args.orderBy ||
+    args.orderDirection ||
+    w ||
+    args.id
+  ) {
     output.push('(\n');
     if (args.first) {
       output.push('first: ', `${args.first}`, '\n');
     }
+    if (args.skip) {
+      output.push('skip: ', `${args.skip}`, '\n');
+    }
     if (args.orderBy) {
       output.push('orderBy: ', args.orderBy, '\n');
     }

diff --git a/packages/subgraph/src/__tests__/createQuery.test.ts b/packages/subgraph/src/__tests__/createQuery.test.ts
@@ -930,6 +930,7 @@ it('prettifies the result', () => {
   const g = createQuery<Query>();
   const query = g.pools
     .first(100)
+    .skip(100)
     .orderBy('liquidity')
     .orderDirection('desc')
     .where((w) => [
@@ -955,6 +956,7 @@ it('prettifies the result', () => {
   const expected = `{
   pools (
     first: 100
+    skip: 100
     orderBy: liquidity
     orderDirection: desc
     where: {