@better-auth-ui/core/dist/plugins/passkey/list-passkeys-query.d.ts

Authentication components and data utilities for [Better Auth](https://better-auth.com), available for React and Solid.

import { QueryClient, QueryOptions, skipToken } from '@tanstack/query-core';
import { InferData } from '../../lib/auth-client';
import { PasskeyAuthClient } from './passkey-auth-client';
/**
 * Data returned by the Better Auth passkey list endpoint.
 */
export type ListPasskeysData<TAuthClient extends PasskeyAuthClient = PasskeyAuthClient> = InferData<TAuthClient["passkey"]["listUserPasskeys"]>;
/**
 * Parameters accepted by the Better Auth passkey list endpoint.
 */
export type ListPasskeysParams<TAuthClient extends PasskeyAuthClient = PasskeyAuthClient> = Parameters<TAuthClient["passkey"]["listUserPasskeys"]>[0];
/**
 * Single passkey item returned by the passkey list endpoint.
 */
export type ListPasskey<TAuthClient extends PasskeyAuthClient = PasskeyAuthClient> = NonNullable<ListPasskeysData<TAuthClient>>[number];
/**
 * Query options for listing passkeys, excluding the generated query key.
 */
export type ListPasskeysOptions<TAuthClient extends PasskeyAuthClient = PasskeyAuthClient> = Omit<QueryOptions<ListPasskeysData<TAuthClient>>, "queryKey"> & ListPasskeysParams<TAuthClient>;
/**
 * Query options factory for listing the current user's passkeys.
 *
 * @param authClient - The Better Auth client with the passkey plugin.
 * @param userId - The current signed-in user's ID. Used for cache partitioning.
 * @param params - Parameters forwarded to the passkey list endpoint.
 */
export declare function listPasskeysOptions<TAuthClient extends PasskeyAuthClient>(authClient: TAuthClient, userId?: string, params?: ListPasskeysParams<TAuthClient>): {
    queryKey: readonly ["auth", "user", string | undefined, "passkey", "list", Record<string, any> | null];
    queryFn: typeof skipToken | (({ signal }: {
        client: QueryClient;
        queryKey: readonly unknown[];
        signal: AbortSignal;
        meta: import('@tanstack/query-core').QueryMeta | undefined;
        pageParam?: unknown;
        direction?: unknown;
    }) => Promise<InferData<TAuthClient["passkey"]["listUserPasskeys"]>>);
};
/**
 * Get passkeys from cache, fetching them if needed.
 */
export declare const ensureListPasskeys: <TAuthClient extends PasskeyAuthClient>(queryClient: QueryClient, authClient: TAuthClient, userId: string, options?: ListPasskeysOptions<TAuthClient>) => Promise<InferData<TAuthClient["passkey"]["listUserPasskeys"]>>;
/**
 * Prefetch passkeys into the query cache.
 */
export declare const prefetchListPasskeys: <TAuthClient extends PasskeyAuthClient>(queryClient: QueryClient, authClient: TAuthClient, userId: string, options?: ListPasskeysOptions<TAuthClient>) => Promise<void>;
/**
 * Fetch and cache passkeys, resolving with data or throwing.
 */
export declare const fetchListPasskeys: <TAuthClient extends PasskeyAuthClient>(queryClient: QueryClient, authClient: TAuthClient, userId: string, options?: ListPasskeysOptions<TAuthClient>) => Promise<InferData<TAuthClient["passkey"]["listUserPasskeys"]>>;
/**
 * Read passkeys synchronously from the query cache.
 */
export declare const getListPasskeys: <TAuthClient extends PasskeyAuthClient = PasskeyAuthClient>(queryClient: QueryClient, _authClient?: TAuthClient, userId?: string, params?: ListPasskeysParams<TAuthClient>) => InferData<TAuthClient["passkey"]["listUserPasskeys"]> | undefined;