fix: Update pagination docs and conditions #238

jdalrymple · Nov 26, 2018 · fecbc17 · fecbc17
1 parent 6a98491
commit fecbc17
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -323,7 +323,7 @@ const api = new Gitlab({
   token: 'abcdefghij123456' // Can be created in your profile.
 });
 
-let projects = await api.Projects.all({maxPages:2});
+let projects = await api.Projects.all({ maxPages:2 });
 
 ```
 
@@ -337,11 +337,12 @@ const api = new Gitlab({
   token: 'abcdefghij123456' // Can be created in your profile.
 });
 
-let projects = await api.Projects.all({maxPages:2, perPage:40});
+let projects = await api.Projects.all({ maxPages:2, perPage:40 });
 
 ```
 
-Additionally, if you would like to get back the pagination information, to know how many total pages there are for example, pass the pagination option:
+Additionally, if you would like to get back the pagination information, to know how many total pages there are for example, pass the pagination option `showPagination` in addition to either the
+`maxPages` or `page` properties.
 
 ```javascript
 ...

diff --git a/src/infrastructure/RequestHelper.ts b/src/infrastructure/RequestHelper.ts
@@ -48,7 +48,7 @@ class RequestHelper {
       return [...body, ...more];
     }
 
-    return showPagination ? { data: body, pagination } : body;
+    return (query.page || maxPages) && showPagination ? { data: body, pagination } : body;
   }
 
   static async stream(service, endpoint: string, options: BaseRequestOptions = ({} = {})) {