@better-auth-ui/core
Version:
Authentication components and data utilities for [Better Auth](https://better-auth.com), available for React and Solid.
40 lines (39 loc) • 3.21 kB
TypeScript
import { DataTag, QueryClient, QueryOptions } from '@tanstack/query-core';
import { APIError } from 'better-auth';
import { OrganizationAuthServer } from '../../../plugins/organization/server/organization-auth-server';
export type ListOrganizationMembersData<TAuth extends OrganizationAuthServer = OrganizationAuthServer> = Awaited<ReturnType<TAuth["api"]["listMembers"]>>;
export type ListOrganizationMembersParams<TAuth extends OrganizationAuthServer = OrganizationAuthServer> = Parameters<TAuth["api"]["listMembers"]>[0];
/**
* Query options factory for members of an organization.
*
* @param auth - The Better Auth server instance.
* @param userId - The signed-in user's ID. Used for cache partitioning so
* the key matches the client-side `listOrganizationMembersOptions` for SSR hydration.
* @param params - Parameters forwarded to `auth.api.listMembers`.
*/
export declare function listOrganizationMembersOptions<TAuth extends OrganizationAuthServer>(auth: TAuth, userId: string, params: ListOrganizationMembersParams<TAuth>): QueryOptions<Awaited<ReturnType<TAuth["api"]["listMembers"]>>, APIError, Awaited<ReturnType<TAuth["api"]["listMembers"]>>, readonly ["auth", "user", string | undefined, "organization", "members", "list", {
limit?: string | number | undefined;
offset?: string | number | undefined;
sortBy?: string | undefined;
sortDirection?: "asc" | "desc" | undefined;
filterField?: string | undefined;
filterValue?: string | number | boolean | string[] | number[] | undefined;
filterOperator?: "in" | "contains" | "starts_with" | "ends_with" | "eq" | "ne" | "gt" | "gte" | "lt" | "lte" | "not_in" | undefined;
organizationId?: string | undefined;
organizationSlug?: string | undefined;
} | null], never> & {
queryKey: DataTag<readonly ["auth", "user", string | undefined, "organization", "members", "list", {
limit?: string | number | undefined;
offset?: string | number | undefined;
sortBy?: string | undefined;
sortDirection?: "asc" | "desc" | undefined;
filterField?: string | undefined;
filterValue?: string | number | boolean | string[] | number[] | undefined;
filterOperator?: "in" | "contains" | "starts_with" | "ends_with" | "eq" | "ne" | "gt" | "gte" | "lt" | "lte" | "not_in" | undefined;
organizationId?: string | undefined;
organizationSlug?: string | undefined;
} | null], Awaited<ReturnType<TAuth["api"]["listMembers"]>>, APIError>;
};
export declare const ensureListOrganizationMembers: <TAuth extends OrganizationAuthServer>(queryClient: QueryClient, auth: TAuth, userId: string, params: ListOrganizationMembersParams<TAuth>) => Promise<Awaited<ReturnType<TAuth["api"]["listMembers"]>>>;
export declare const prefetchListOrganizationMembers: <TAuth extends OrganizationAuthServer>(queryClient: QueryClient, auth: TAuth, userId: string, params: ListOrganizationMembersParams<TAuth>) => Promise<void>;
export declare const fetchListOrganizationMembers: <TAuth extends OrganizationAuthServer>(queryClient: QueryClient, auth: TAuth, userId: string, params: ListOrganizationMembersParams<TAuth>) => Promise<Awaited<ReturnType<TAuth["api"]["listMembers"]>>>;