Class PostgrestBuilder<Result, ThrowOnError> Abstract

Type Parameters

Result
ThrowOnError extends boolean = false

Hierarchy

PostgrestBuilder
- PostgrestTransformBuilder

Implements

PromiseLike<ThrowOnError extends true ? PostgrestResponseSuccess<Result> : PostgrestSingleResponse<Result>>

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new PostgrestBuilder<Result, ThrowOnError>(builder: PostgrestBuilder<Result, false>): PostgrestBuilder<Result, ThrowOnError>

- Defined in src/PostgrestBuilder.ts:23
Type Parameters
- Result
- ThrowOnError extends boolean = false
Parameters
- builder: PostgrestBuilder<Result, false>
Returns PostgrestBuilder<Result, ThrowOnError>

Properties

Protected Optional body

body?: unknown

Protected fetch

fetch: ((input: RequestInfo | URL, init?: RequestInit) => Promise<Response>)

Type declaration

- (input: RequestInfo | URL, init?: RequestInit): Promise<Response>
- Parameters
  - input: RequestInfo | URL
  - Optional init: RequestInit
  Returns Promise<Response>

Protected headers

headers: Record<string, string>

Protected isMaybeSingle

isMaybeSingle: boolean

Protected method

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

Protected Optional schema

schema?: string

Protected shouldThrowOnError

shouldThrowOnError: boolean = false

Protected Optional signal

signal?: AbortSignal

Protected url

url: URL

Methods

setHeader

setHeader(name: string, value: string): PostgrestBuilder<Result, ThrowOnError>

- Defined in src/PostgrestBuilder.ts:56
Set an HTTP header for the request.

Parameters
- name: string
- value: string
Returns PostgrestBuilder<Result, ThrowOnError>

then

then<TResult1, TResult2>(onfulfilled?: null | ((value: ThrowOnError extends true ? PostgrestResponseSuccess<Result> : PostgrestSingleResponse<Result>) => TResult1 | PromiseLike<TResult1>), onrejected?: null | ((reason: any) => TResult2 | PromiseLike<TResult2>)): PromiseLike<TResult1 | TResult2>

Implementation of PromiseLike.then
- Defined in src/PostgrestBuilder.ts:62
Type Parameters
- TResult1 = ThrowOnError extends true ? PostgrestResponseSuccess<Result> : PostgrestSingleResponse<Result>
- TResult2 = never
Parameters
- Optional onfulfilled: null | ((value: ThrowOnError extends true ? PostgrestResponseSuccess<Result> : PostgrestSingleResponse<Result>) => TResult1 | PromiseLike<TResult1>)
- Optional onrejected: null | ((reason: any) => TResult2 | PromiseLike<TResult2>)
Returns PromiseLike<TResult1 | TResult2>

throwOnError

throwOnError(): PostgrestBuilder<Result, ThrowOnError> & PostgrestBuilder<Result, true>

- Defined in src/PostgrestBuilder.ts:48
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

Returns PostgrestBuilder<Result, ThrowOnError> & PostgrestBuilder<Result, true>

Generated using TypeDoc