@lens-protocol/react/dist/declarations/src/discovery/useSearchProfiles.d.ts

Interacting with the Lens Protocol API using React.

import { Profile, ProfileSearchRequest, ProfileSearchWhere } from '@lens-protocol/api-bindings';
import { PaginatedArgs, PaginatedReadResult } from "../helpers/reads.js";
import { SuspenseEnabled, SuspensePaginatedResult } from "../helpers/suspense.js";
/**
 * {@link useSearchProfiles} hook arguments
 */
export type UseSearchProfilesArgs = PaginatedArgs<ProfileSearchRequest>;
export type { ProfileSearchRequest, ProfileSearchWhere };
/**
 * {@link useSearchProfiles} hook arguments with Suspense support
 *
 * @experimental This API can change without notice
 */
export type UseSuspenseSearchProfilesArgs = SuspenseEnabled<UseSearchProfilesArgs>;
/**
 * `useSearchProfiles` is a paginated hook that lets you search for profiles based on a defined criteria
 *
 * ```tsx
 * function SearchProfiles() {
 *   const { data, error, loading } = useSearchProfiles({ query: 'foo' });
 *
 *   if (loading) return <Loader />;
 *
 *   if (error) return <Error message={error.message} />;
 *
 *   return (
 *     <ul>
 *       {data.map((profile) => (
 *         <li key={profile.id}>{profile.handle}</li>
 *       ))}
 *     </ul>
 *   );
 * }
 * ```
 *
 * @category Discovery
 * @group Hooks
 */
export declare function useSearchProfiles(args: UseSearchProfilesArgs): PaginatedReadResult<Profile[]>;
/**
 * `useSearchProfiles` is a paginated hook that lets you search for profiles based on a defined criteria
 *
 * This signature supports [React Suspense](https://react.dev/reference/react/Suspense).
 *
 * ```tsx
 * const { data } = useSearchProfiles({
 *   query: 'foo',
 *   suspense: true,
 * });
 *
 * console.log(data);
 * ```
 *
 * Use [startTransition](https://react.dev/reference/react/startTransition) to avoid to re-suspend the component.
 *
 * ```tsx
 * const [query, setQuery] = useState('bob');
 *
 * const { data } = useSearchProfiles({
 *   query,
 *   suspense: true,
 * });
 *
 * const search = () => {
 *   startTransition(() => {
 *     setQuery('foo');
 *   });
 * };
 * ```
 *
 * @experimental This API can change without notice
 * @category Discovery
 * @group Hooks
 */
export declare function useSearchProfiles(args: UseSuspenseSearchProfilesArgs): SuspensePaginatedResult<Profile[]>;