feat: support setting AbortSignal

Author: soedirgo

package-lock.json

@@ -37,6 +37,7 @@
     "@types/node-fetch": "^2.5.7",
     "genversion": "^3.0.1",
     "jest": "^26.4.1",
+    "node-abort-controller": "^3.0.0",
     "npm-run-all": "^4.1.5",
     "prettier": "^2.0.5",
     "rimraf": "^3.0.2",

package.json

@@ -85,6 +85,14 @@ export default class PostgrestTransformBuilder<T> extends PostgrestBuilder<T> {
     return this
   }
 
+  /**
+   * Sets the AbortSignal for the fetch request.
+   */
+  abortSignal(signal: AbortSignal): this {
+    this.signal = signal
+    return this
+  }
+
   /**
    * Retrieves only one row from the result. Result must be one row (e.g. using
    * `limit`), otherwise this will result in an error.

src/lib/PostgrestTransformBuilder.ts

@@ -55,6 +55,7 @@ export abstract class PostgrestBuilder<T> implements PromiseLike<PostgrestRespon
   protected schema?: string
   protected body?: Partial<T> | Partial<T>[]
   protected shouldThrowOnError = false
+  protected signal?: AbortSignal
 
   constructor(builder: PostgrestBuilder<T>) {
     Object.assign(this, builder)
@@ -94,6 +95,7 @@ export abstract class PostgrestBuilder<T> implements PromiseLike<PostgrestRespon
       method: this.method,
       headers: this.headers,
       body: JSON.stringify(this.body),
+      signal: this.signal,
     }).then(async (res) => {
       let error = null
       let data = null

src/lib/types.ts

@@ -1,5 +1,7 @@
 import { PostgrestClient } from '../src/index'
 
+import { AbortController } from 'node-abort-controller'
+
 const postgrest = new PostgrestClient('http://localhost:3000')
 
 test('order', async () => {
@@ -78,3 +80,24 @@ test('csv', async () => {
     }
   `)
 })
+
+test('abort signal', async () => {
+  const ac = new AbortController()
+  ac.abort()
+  const res = await postgrest.from('users').select().abortSignal(ac.signal)
+  expect(res).toMatchInlineSnapshot(`
+    Object {
+      "body": null,
+      "count": null,
+      "data": null,
+      "error": Object {
+        "code": "",
+        "details": "",
+        "hint": "",
+        "message": "FetchError: The user aborted a request.",
+      },
+      "status": 400,
+      "statusText": "Bad Request",
+    }
+  `)
+})