Add option for forcing a REST API call

Author: axelrindle

packages/api/src/index.ts

@@ -40,6 +40,11 @@ export interface CheckOptions {
      * Currently only works when no token is specified.
      */
     excludePrereleases?: boolean
+
+    /**
+     * Will use the Github REST API (v3) even with a supplied token.
+     */
+    forceRest?: boolean
 }
 
 /**

packages/core/src/check.ts

@@ -31,7 +31,9 @@ const check: CheckFunction = async function(options: CheckOptions): Promise<Chec
 
     // decide what to do
     // when we have a token supplied, we will call the GraphQL API
-    if (options.token) {
+    if (options.forceRest) {
+        return await rest(options)
+    } else if (options.token) {
         return await graphql(options)
     } else {
         return await rest(options)

packages/core/test/test-graphql.ts

@@ -16,7 +16,7 @@ test('graphql returns the same releases answer as rest', async (t) => {
     const responseGraphql = await versionCheck(opts) as CheckResult
     t.not(responseGraphql, undefined)
 
-    const responseRest = await versionCheck({ ...opts, token: false }) as CheckResult
+    const responseRest = await versionCheck({ ...opts, forceRest: true }) as CheckResult
     t.not(responseRest, undefined)
 
     t.is(responseGraphql.src, 'graphql')
@@ -28,7 +28,7 @@ test('graphql returns the same tags answer as rest', async (t) => {
     const responseGraphql = await versionCheck({ ...opts, fetchTags: true }) as CheckResult
     t.not(responseGraphql, undefined)
 
-    const responseRest = await versionCheck({ ...opts, token: false, fetchTags: true }) as CheckResult
+    const responseRest = await versionCheck({ ...opts, forceRest: true, fetchTags: true }) as CheckResult
     t.not(responseRest, undefined)
 
     t.is(responseGraphql.src, 'graphql')