@supabase-kit/react
Version:
> Hooks by management data from supabase and fetch data by react.
52 lines (51 loc) • 7.18 kB
TypeScript
import { SupabaseClient } from '@supabase/supabase-js';
import { DatabaseTemp } from './query';
import { GetSupaQUeryNameProps } from './utils/getName';
export declare const createSupabaseTools: <D extends DatabaseTemp = any>(client: SupabaseClient<D>) => {
useSupaSubscription: ({ table, schema, event, where, type, channel, callback, }: import("./subscription/types").SupaSubscriptionProps<D, "*", "toLocaleString" | keyof D["public"]["Tables"] | "toString" | "valueOf", (D["public"]["Tables"] & D["public"]["Views"])["toLocaleString" | keyof D["public"]["Tables"] | "toString" | "valueOf"]["Row"]>) => void;
useSupaRealtime: <T extends keyof D["public"]["Tables"] & string>({ table, where, channel, }: Omit<import("./subscription/types").SupaSubscriptionProps<D, "*", "toLocaleString" | keyof D["public"]["Tables"] | "toString" | "valueOf", (D["public"]["Tables"] & D["public"]["Views"])["toLocaleString" | keyof D["public"]["Tables"] | "toString" | "valueOf"]["Row"]>, "event" | "type" | "callback"> & {
table: T;
}) => import("@tanstack/react-query").UseQueryResult<import("./query").SupabaseQueryResult<D["public"]["Tables"][("toLocaleString" | keyof D["public"]["Tables"] | "toString" | "valueOf") & T]["Row"][]>, import("@supabase/postgrest-js").PostgrestError>;
useSupaInfiniteQuery: <T extends keyof D["public"]["Tables"] & keyof D["public"]["Views"] & string>({ table, column, options, enabled, count, ...configObj }: import("./query").SupabaseInfoniteQueryConfig<D, (keyof D["public"]["Tables"] | keyof D["public"]["Views"]) & string & keyof (D["public" extends keyof D ? keyof D & "public" : string & keyof D] extends import("@supabase/supabase-js/dist/module/lib/types").GenericSchema ? D["public" extends keyof D ? keyof D & "public" : string & keyof D] : any)["Views"], (D["public"]["Tables"] & D["public"]["Views"])[(keyof D["public"]["Tables"] | keyof D["public"]["Views"]) & string & keyof (D["public" extends keyof D ? keyof D & "public" : string & keyof D] extends import("@supabase/supabase-js/dist/module/lib/types").GenericSchema ? D["public" extends keyof D ? keyof D & "public" : string & keyof D] : any)["Views"]]["Row"][]> & {
table: T;
}) => import("@tanstack/react-query").DefinedUseInfiniteQueryResult<import("@tanstack/query-core").InfiniteData<import("./query").SupabaseQueryResult<D["public"]["Tables"][T]["Row"][]>, unknown>, import("@supabase/postgrest-js").PostgrestError>;
useSupaQuery: {
<T extends keyof D["public"]["Tables"] | keyof D["public"]["Views"]>(config: import("./query").SupabaseQueryConfig<D, keyof D["public"]["Tables"] | keyof D["public"]["Views"], boolean, (D["public"]["Tables"] | D["public"]["Views"])[keyof D["public"]["Tables"] | keyof D["public"]["Views"]]["Row"] | (D["public"]["Tables"] | D["public"]["Views"])[keyof D["public"]["Tables"] | keyof D["public"]["Views"]]["Row"][]> & {
table: T;
single: true;
}): import("@tanstack/react-query").UseQueryResult<import("./query").SupabaseQueryResult<D["public"]["Tables"][T]["Row"]>, import("@supabase/postgrest-js").PostgrestError>;
<T extends keyof D["public"]["Tables"] | keyof D["public"]["Views"]>(config: import("./query").SupabaseQueryConfig<D, keyof D["public"]["Tables"] | keyof D["public"]["Views"], boolean, (D["public"]["Tables"] | D["public"]["Views"])[keyof D["public"]["Tables"] | keyof D["public"]["Views"]]["Row"] | (D["public"]["Tables"] | D["public"]["Views"])[keyof D["public"]["Tables"] | keyof D["public"]["Views"]]["Row"][]> & {
table: T;
single?: false;
}): import("@tanstack/react-query").UseQueryResult<import("./query").SupabaseQueryResult<D["public"]["Tables"][T]["Row"][]>, import("@supabase/postgrest-js").PostgrestError>;
};
QueryBuilder: <D_1 extends DatabaseTemp, SchemaName extends string & keyof D_1 = "public" extends keyof D_1 ? "public" : string & keyof D_1, Schema extends import("@supabase/supabase-js/dist/module/lib/types").GenericSchema = D_1[SchemaName] extends import("@supabase/supabase-js/dist/module/lib/types").GenericSchema ? D_1[SchemaName] : any>({ where, ...options }: {
options?: (Omit<import("@tanstack/react-query").UseQueryOptions<import("./query").SupabaseQueryResult<(D_1["public"]["Tables"] | D_1["public"]["Views"])[keyof D_1["public"]["Tables"] | keyof D_1["public"]["Views"]]["Row"] | (D_1["public"]["Tables"] | D_1["public"]["Views"])[keyof D_1["public"]["Tables"] | keyof D_1["public"]["Views"]]["Row"][]>, import("@supabase/postgrest-js").PostgrestError, import("./query").SupabaseQueryResult<(D_1["public"]["Tables"] | D_1["public"]["Views"])[keyof D_1["public"]["Tables"] | keyof D_1["public"]["Views"]]["Row"] | (D_1["public"]["Tables"] | D_1["public"]["Views"])[keyof D_1["public"]["Tables"] | keyof D_1["public"]["Views"]]["Row"][]>, import("@tanstack/query-core").QueryKey>, "queryKey" | "queryFn"> & {
queryKey?: string[];
}) | undefined;
enabled?: boolean | undefined;
where?: import("./query").Where<(D_1["public"]["Tables"] | D_1["public"]["Views"])[keyof D_1["public"]["Tables"] | keyof D_1["public"]["Views"]]["Row"] | (D_1["public"]["Tables"] | D_1["public"]["Views"])[keyof D_1["public"]["Tables"] | keyof D_1["public"]["Views"]]["Row"][]> | undefined;
limit?: number | undefined;
single?: boolean | undefined;
maybeSingle?: boolean | undefined;
order?: Partial<Record<((D_1["public"]["Tables"] | D_1["public"]["Views"])[keyof D_1["public"]["Tables"] | keyof D_1["public"]["Views"]]["Row"] extends infer T ? T extends (D_1["public"]["Tables"] | D_1["public"]["Views"])[keyof D_1["public"]["Tables"] | keyof D_1["public"]["Views"]]["Row"] ? T extends any[] ? keyof T[0] : keyof T : never : never) | keyof (D_1["public"]["Tables"] | D_1["public"]["Views"])[keyof D_1["public"]["Tables"] | keyof D_1["public"]["Views"]]["Row"], {
ascending?: boolean;
nullsFirst?: boolean;
foreignTable?: string;
referencedTable?: string;
}>> | undefined;
range?: (import("./query").baseRangeWhere | import("./query").baseRangeWhere[]) | undefined;
csv?: boolean | undefined;
explain?: {
analyze?: boolean;
verbose?: boolean;
settings?: boolean;
buffers?: boolean;
wal?: boolean;
format?: "json" | "text";
} | undefined;
}, Query: import("@supabase/postgrest-js").PostgrestFilterBuilder<Schema, any, any>) => import("@supabase/postgrest-js").PostgrestFilterBuilder<Schema, any, any, unknown, unknown>;
useSupabase: () => SupabaseClient<D, "public" extends keyof D ? keyof D & "public" : string & keyof D, D["public" extends keyof D ? keyof D & "public" : string & keyof D] extends import("@supabase/supabase-js/dist/module/lib/types").GenericSchema ? D["public" extends keyof D ? keyof D & "public" : string & keyof D] : any>;
useSupaSession: () => import("@tanstack/react-query").DefinedUseQueryResult<import("@supabase/auth-js").Session | null, Error>;
getSupaQueryName: ({ table, queryKey }: GetSupaQUeryNameProps<D>) => string;
};