Skip to main content

Function: useLinkAddress()

useLinkAddress(params?: {mutation: MutationOptions<LinkedAddress, Error, LinkAddress>; }): MutationResult<"linkAddress", LinkedAddress, Error, LinkAddress>

Add address to profile.

Parameters​

ParameterTypeDescription
params?objectNo required parameters.
params.mutation?MutationOptions<LinkedAddress, Error, LinkAddress>See Tanstack Query - useMutation options.

Returns​

MutationResult<"linkAddress", LinkedAddress, Error, LinkAddress>

Example​

const {
   linkAddress, // useMutation's `mutateAsync` property
   isPending,
   isError,
   error,
   status,
   ...moreUseMutationResults
} = useLinkAddress();

See​

API Documentation

Defined in​

sdk-react-provider/src/lib/hooks.tsx:965