Add pagination to search endpoints

lib/GitHub.js

@@ -91,11 +91,11 @@ class GitHub {
 
    /**
     * Create a new Search wrapper
-    * @param {string} query - the query to search for
+    * @param {Search.Params} searchParameters - the query and other search parameters
     * @return {Search}
     */
-   search(query) {
-      return new Search(query, this.__auth, this.__apiBase);
+   search(searchParameters) {
+      return new Search(searchParameters, this.__auth, this.__apiBase);
    }
 
    /**

lib/Requestable.js

@@ -235,13 +235,30 @@ class Requestable {
     * @param {string} path - the path to request
     * @param {Object} options - the query parameters to include
     * @param {Requestable.callback} [cb] - the function to receive the data. The returned data will always be an array.
-    * @param {Object[]} results - the partial results. This argument is intended for internal use only.
     * @return {Promise} - a promise which will resolve when all pages have been fetched
     * @deprecated This will be folded into {@link Requestable#_request} in the 2.0 release.
     */
-   _requestAllPages(path, options, cb, results) {
-      results = results || [];
+   _requestAllPages(path, options, cb) {
+      let manualPagination = false;
+      if (typeof options.page !== 'undefined') {
+         manualPagination = true;
+      }
+
+      return this._requestAllPagesHelper(path, options, cb, [], manualPagination);
+   }
 
+   /**
+    * Perform the logic of fetching multiple pages
+    * @private
+    * @param {string} path - the path to request
+    * @param {Object} options - the query parameters to include
+    * @param {Requestable.callback} [cb] - the function to receive the data. The returned data will always be an array.
+    * @param {Object[]} results - the partial results. This argument is intended for internal use only.
+    * @param {boolean} manualPagination - the flag to decide if multiple pages should be fetched
+    * @return {Promise} - a promise which will resolve when all pages have been fetched
+    * @deprecated This will be folded into {@link Requestable#_request} in the 2.0 release.
+    */
+   _requestAllPagesHelper(path, options, cb, results, manualPagination) {
       return this._request('GET', path, options)
          .then((response) => {
             let thisGroup;
@@ -256,19 +273,19 @@ class Requestable {
             results.push(...thisGroup);
 
             const nextUrl = getNextPage(response.headers.link);
-            if(nextUrl) {
+            if(nextUrl && !manualPagination) {
                if (!options) {
                   options = {};
                }
                options.page = parseInt(
-                 nextUrl.match(/([&\?]page=[0-9]*)/g)
-                   .shift()
-                   .split('=')
-                   .pop()
+                  nextUrl.match(/([&\?]page=[0-9]*)/g)
+                     .shift()
+                     .split('=')
+                     .pop()
                );
                if (!(options && typeof options.page !== 'number')) {
                   log(`getting next page: ${nextUrl}`);
-                  return this._requestAllPages(nextUrl, options, cb, results);
+                  return this._requestAllPagesHelper(nextUrl, options, cb, results, false);
                }
             }
 

lib/Search.js

@@ -32,6 +32,8 @@ class Search extends Requestable {
     * @param {string} sort - the sort field, one of `stars`, `forks`, or `updated`.
     *                      Default is [best match](https://developer.github.com/v3/search/#ranking-search-results)
     * @param {string} order - the ordering, either `asc` or `desc`
+    * @param {number} page - the page number to fetch, for manual pagination
+    * @param {number} per_page - the number of results to fetch per page, for manual pagination
     */
    /**
     * Perform a search on the GitHub API