feat: ✨ add content-range header on getList routes

doralteres · Sep 8, 2023 · 6805c8f · 6805c8f
1 parent 4fda39e
commit 6805c8f
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 4 deletions.
diff --git a/example/index.ts b/example/index.ts
@@ -24,7 +24,11 @@ initDB().then(sequelize => {
       users: {
         model: users,
         operations: {
-          getList: {filterableFields: ['id', 'gender'], limit: 100},
+          getList: {
+            pagination: true,
+            filterableFields: ['id', 'gender'],
+            limit: 100,
+          },
           getOne: {attributes: ['id', 'fullName']},
           create: {
             creatableFields: {exclude: ['id']},

diff --git a/src/middleware/query.ts b/src/middleware/query.ts
@@ -70,3 +70,15 @@ export const checkSortableFields = (sortableFields: customFields = []) => {
     }
   };
 };
+
+export const setContentRange = (
+  res: Response,
+  key: string,
+  offset: number,
+  length: number,
+  total: number
+) => {
+  const range =
+    length === 0 ? '0-0/0' : `${offset}-${offset + length}/${total}`;
+  res.setHeader('Content-Range', `${key} ${range}`);
+};
diff --git a/src/routes/getList.ts b/src/routes/getList.ts
@@ -10,8 +10,8 @@ import {
   buildOptionsFromQueryParams,
   checkFilterableFields,
   checkSortableFields,
+  setContentRange,
 } from '../middleware/query';
-import {SequelizeScopeError} from 'sequelize';
 import {getSequelizeErrorMessage} from '../utils';
 
 const getListRoute = (
@@ -49,8 +49,14 @@ const getListRoute = (
             ...queryOptions,
             where: {...options.where, ...queryOptions.where},
           });
-          // TODO: set PAGINATION
-          res.json({rows, count});
+          setContentRange(
+            res,
+            model.name,
+            queryOptions.offset || 0,
+            rows.length,
+            count
+          );
+          res.json(rows);
         } else {
           const data = await model.findAll({
             ...options,