Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PostgrestBuilder<Result, ThrowOnError> Abstract

Type Parameters

  • Result

  • ThrowOnError extends boolean = false

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

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

overrideTypes

  • overrideTypes<NewResult, Options>(): PostgrestBuilder<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>

  • 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<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<CheckMatchingArrayTypes<Result, NewResult>, ThrowOnError>

  • 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<CheckMatchingArrayTypes<Result, NewResult>, ThrowOnError>

setHeader

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>

throwOnError

Generated using TypeDoc