Class PostgrestRpcBuilder<T>

Type parameters

T

Hierarchy

PostgrestBuilder<T>
- PostgrestRpcBuilder

Implements

PromiseLike<PostgrestResponse<T>>

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new PostgrestRpcBuilder(url: string, __namedParameters?: { fetch: undefined | fetch; headers: {}; schema: undefined | string; shouldThrowOnError: undefined | false | true }): PostgrestRpcBuilder

Overrides PostgrestBuilder.constructor
- Defined in lib/PostgrestRpcBuilder.ts:4
Parameters
- url: string
- Default value __namedParameters: { fetch: undefined | fetch; headers: {}; schema: undefined | string; shouldThrowOnError: undefined | false | true } = {}
  - fetch: undefined | fetch
  - headers: {}
    - [key: string]: string
  - schema: undefined | string
  - shouldThrowOnError: undefined | false | true
Returns PostgrestRpcBuilder

Properties

Protected allowEmpty

allowEmpty: boolean

Protected Optional body

body: Partial<T> | Partial<T>[]

Protected fetch

fetch: Fetch

Protected headers

headers: {}

Type declaration

[key: string]: string

Protected method

method: "GET" | "HEAD" | "POST" | "PATCH" | "DELETE"

Protected Optional schema

schema: undefined | string

Protected shouldThrowOnError

shouldThrowOnError: boolean

Protected Optional signal

signal: AbortSignal

Protected url

url: URL

Methods

rpc

rpc(params?: undefined | object, __namedParameters?: { count: null | "exact" | "planned" | "estimated"; head: boolean }): PostgrestFilterBuilder<T>

- Defined in lib/PostgrestRpcBuilder.ts:28
Perform a function call.

Parameters
- Optional params: undefined | object
- Default value __namedParameters: { count: null | "exact" | "planned" | "estimated"; head: boolean } = {}
  - count: null | "exact" | "planned" | "estimated"
  - head: boolean
Returns PostgrestFilterBuilder<T>

then

then<TResult1, TResult2>(onfulfilled?: ((value: PostgrestResponse<T>) => TResult1 | PromiseLike<TResult1>) | undefined | null, onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | undefined | null): PromiseLike<TResult1 | TResult2>

Inherited from PostgrestBuilder.then
- Defined in lib/types.ts:91
Type parameters
- TResult1 = PostgrestResponse<T>
- TResult2 = never
Parameters
- Optional onfulfilled: ((value: PostgrestResponse<T>) => TResult1 | PromiseLike<TResult1>) | undefined | null
- Optional onrejected: ((reason: any) => TResult2 | PromiseLike<TResult2>) | undefined | null
Returns PromiseLike<TResult1 | TResult2>

throwOnError

throwOnError(throwOnError?: undefined | false | true): this

Inherited from PostgrestBuilder.throwOnError
- Defined in lib/types.ts:83
If there's an error with the query, throwOnError will reject the promise by throwing the error instead of returning it as part of a successful response.

https://github.com/supabase/supabase-js/issues/92

Parameters
- Optional throwOnError: undefined | false | true
Returns this

Generated using TypeDoc