feat: support HEAD for RPC (#215)

* Allow customizing RPC request method

* Update test snapshots

* Add comments

* Remove `GET` HTTP method

Author: bnjmnt4n

src/PostgrestClient.ts

@@ -49,21 +49,24 @@ export default class PostgrestClient {
    *
    * @param fn  The function name to call.
    * @param params  The parameters to pass to the function call.
+   * @param head  When set to true, no data will be returned.
    * @param count  Count algorithm to use to count rows in a table.
    */
   rpc<T = any>(
     fn: string,
     params?: object,
     {
+      head = false,
       count = null,
     }: {
+      head?: boolean
       count?: null | 'exact' | 'planned' | 'estimated'
     } = {}
   ): PostgrestFilterBuilder<T> {
     const url = `${this.url}/rpc/${fn}`
     return new PostgrestRpcBuilder<T>(url, {
       headers: this.headers,
       schema: this.schema,
-    }).rpc(params, { count })
+    }).rpc(params, { head, count })
   }
 }

src/lib/PostgrestRpcBuilder.ts

@@ -18,13 +18,25 @@ export default class PostgrestRpcBuilder<T> extends PostgrestBuilder<T> {
   rpc(
     params?: object,
     {
+      head = false,
       count = null,
     }: {
+      head?: boolean
       count?: null | 'exact' | 'planned' | 'estimated'
     } = {}
   ): PostgrestFilterBuilder<T> {
-    this.method = 'POST'
-    this.body = params
+    if (head) {
+      this.method = 'HEAD'
+
+      if (params) {
+        Object.entries(params).forEach(([name, value]) => {
+          this.url.searchParams.append(name, value)
+        })
+      }
+    } else {
+      this.method = 'POST'
+      this.body = params
+    }
 
     if (count) {
       if (this.headers['Prefer'] !== undefined) this.headers['Prefer'] += `,count=${count}`

test/__snapshots__/index.test.ts.snap

@@ -2004,6 +2004,17 @@ Object {
 }
 `;
 
+exports[`rpc with head:true, count:exact 1`] = `
+Object {
+  "body": null,
+  "count": 1,
+  "data": null,
+  "error": null,
+  "status": 200,
+  "statusText": "OK",
+}
+`;
+
 exports[`select on insert 1`] = `
 Object {
   "body": Array [

test/basic.ts

@@ -213,6 +213,15 @@ test("rpc with count: 'exact'", async () => {
   expect(res).toMatchSnapshot()
 })
 
+test('rpc with head:true, count:exact', async () => {
+  const res = await postgrest.rpc(
+    'get_status',
+    { name_param: 'supabot' },
+    { head: true, count: 'exact' }
+  )
+  expect(res).toMatchSnapshot()
+})
+
 describe("insert, update, delete with count: 'exact'", () => {
   test("insert with count: 'exact'", async () => {
     let res = await postgrest

tsconfig.json

@@ -8,6 +8,7 @@
     "rootDir": "src",
     "sourceMap": true,
     "target": "ES2015",
+    "lib": ["dom", "ES2017"],
 
     "strict": true,