Skip to main content
function useLinkApple(): {
  linkApple: (options?: {
     idempotencyKey?: string;
  }) => Promise<void>;
  oauthState:   | null
     | OAuthFlowState;
};
A hook for linking an Apple account to the current user. This is a convenience wrapper around useLinkOAuth for Apple provider.

​
Returns

{
  linkApple: (options?: {
     idempotencyKey?: string;
  }) => Promise<void>;
  oauthState:   | null
     | OAuthFlowState;
}
An object containing the linkApple function and oauthState.
NameType
linkApple()(options?: { idempotencyKey?: string; }) => Promise<void>
oauthState| null | OAuthFlowState