PostgrestBuilder | @supabase/postgrest-js

Type Parameters

ClientOptions extends ClientServerOptions
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<ClientOptions, Result, ThrowOnError>(builder: { body?: unknown; fetch?: ((input: RequestInfo | URL, init?: RequestInit) => Promise<Response>); headers: HeadersInit; isMaybeSingle?: boolean; method: "GET" | "HEAD" | "POST" | "PATCH" | "DELETE"; schema?: string; shouldThrowOnError?: boolean; signal?: AbortSignal; url: URL }): PostgrestBuilder<ClientOptions, Result, ThrowOnError>

- Defined in src/PostgrestBuilder.ts:35
Type Parameters
- ClientOptions extends ClientServerOptions
- Result
- ThrowOnError extends boolean = false
Parameters
- builder: { body?: unknown; fetch?: ((input: RequestInfo | URL, init?: RequestInit) => Promise<Response>); headers: HeadersInit; isMaybeSingle?: boolean; method: "GET" | "HEAD" | "POST" | "PATCH" | "DELETE"; schema?: string; shouldThrowOnError?: boolean; signal?: AbortSignal; url: URL }
  - Optional body?: unknown
  - Optional fetch?: ((input: RequestInfo | URL, init?: RequestInit) => Promise<Response>)
    - - (input: RequestInfo | URL, init?: RequestInit): Promise<Response>
      - Parameters
        input: RequestInfo | URL
        Optional init: RequestInit
        Returns Promise<Response>
  - headers: HeadersInit
  - Optional isMaybeSingle?: boolean
  - method: "GET" | "HEAD" | "POST" | "PATCH" | "DELETE"
  - Optional schema?: string
  - Optional shouldThrowOnError?: boolean
  - Optional signal?: AbortSignal
  - url: URL
Returns PostgrestBuilder<ClientOptions, 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: Headers

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

overrideTypes

overrideTypes<NewResult, Options>(): PostgrestBuilder<ClientOptions, IsValidResultOverride<Result, NewResult, false, false> extends true ? ContainsNull<Result> extends true ? null | MergePartialResult<NewResult, NonNullable<Result>, Options> : MergePartialResult<NewResult, Result, Options> : CheckMatchingArrayTypes<Result, NewResult>, ThrowOnError>

- Defined in src/PostgrestBuilder.ts:276
Override the type of the returned data field in the response.
example
```
// Merge with existing types (default behavior)
const query = supabase
  .from('users')
  .select()
  .overrideTypes<{ custom_field: string }>()

// Replace existing types completely
const replaceQuery = supabase
  .from('users')
  .select()
  .overrideTypes<{ id: number; name: string }, { merge: false }>()
```
Type Parameters
- NewResult
  
  The new type to cast the response data to
- Options extends { merge?: boolean } = { merge: true }
  
  Optional type configuration (defaults to { merge: true })
Returns PostgrestBuilder<ClientOptions, IsValidResultOverride<Result, NewResult, false, false> extends true ? ContainsNull<Result> extends true ? null | MergePartialResult<NewResult, NonNullable<Result>, Options> : MergePartialResult<NewResult, Result, Options> : CheckMatchingArrayTypes<Result, NewResult>, ThrowOnError>
A PostgrestBuilder instance with the new type

returns

returns<NewResult>(): PostgrestBuilder<ClientOptions, CheckMatchingArrayTypes<Result, NewResult>, ThrowOnError>

- Defined in src/PostgrestBuilder.ts:241
Override the type of the returned data.

deprecated
Use overrideTypes<yourType, { merge: false }>() method at the end of your call chain instead

Type Parameters
- NewResult
  
  The new result type to override with
Returns PostgrestBuilder<ClientOptions, CheckMatchingArrayTypes<Result, NewResult>, ThrowOnError>

setHeader

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

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

Parameters
- name: string
- value: string
Returns PostgrestBuilder<ClientOptions, 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:84
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<ClientOptions, Result, ThrowOnError> & PostgrestBuilder<ClientOptions, Result, true>

- Defined in src/PostgrestBuilder.ts:70
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<ClientOptions, Result, ThrowOnError> & PostgrestBuilder<ClientOptions, Result, true>

Type Parameters

ClientOptions extends ClientServerOptions

Result

ThrowOnError extends boolean = false

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

ClientOptions extends ClientServerOptions

Result

ThrowOnError extends boolean = false

Parameters

builder: { body?: unknown; fetch?: ((input: RequestInfo | URL, init?: RequestInit) => Promise<Response>); headers: HeadersInit; isMaybeSingle?: boolean; method: "GET" | "HEAD" | "POST" | "PATCH" | "DELETE"; schema?: string; shouldThrowOnError?: boolean; signal?: AbortSignal; url: URL }

Optional body?: unknown

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

Parameters

input: RequestInfo | URL

Optional init: RequestInit

Returns Promise<Response>

headers: HeadersInit

Optional isMaybeSingle?: boolean

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

Optional schema?: string

Optional shouldThrowOnError?: boolean

Optional signal?: AbortSignal

url: URL

Returns PostgrestBuilder<ClientOptions, Result, ThrowOnError>

Properties

Protected Optional body

Protected fetch

Type declaration

Parameters

input: RequestInfo | URL

Optional init: RequestInit

Returns Promise<Response>

Protected headers

Protected isMaybeSingle

Protected method

Protected Optional schema

Protected shouldThrowOnError

Protected Optional signal

Protected url

Methods

overrideTypes

Type Parameters

NewResult

Options extends { merge?: boolean } = { merge: true }

returns

Type Parameters

NewResult

Returns PostgrestBuilder<ClientOptions, CheckMatchingArrayTypes<Result, NewResult>, ThrowOnError>

setHeader

Parameters

name: string

value: string

Returns PostgrestBuilder<ClientOptions, Result, ThrowOnError>

then

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

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