Skip to main content

Function: useProfile()

useProfile(params: { profile: string; query: QueryOptions<Profile>; }): UseQueryResult<Profile, Error>

If no profile id is provided, the default profile is used.

Parameters

ParameterTypeDescription
params{ profile: string; query: QueryOptions<Profile>; }
params.profile?stringThe id of the profile
params.query?QueryOptions<Profile>See Tanstack Query - useQuery options.

Returns

UseQueryResult<Profile, Error>

Example

const {
data
isLoading,
isError,
error,
refetch,
...moreUseQueryResults
} = useProfile();

See

API Documentation