useSetEmail

1function useSetEmail(mutationArgs?): UseSetEmailResult;

Defined in: account-kit/react/src/hooks/useSetEmail.ts:76

A custom hook to set an email address for an already authenticated account.

Note: You should first use the useSendVerificationCode hook to send a verification code to the email address before calling this hook.

Example

import { 
function useSetEmail(mutationArgs?: UseSetEmailMutationArgs): UseSetEmailResult

A custom hook to set an email address for an already authenticated account.

Note: You should first use the useSendVerificationCode hook to send a verification code to the email address before calling this hook.

useSetEmail
,
function useSendVerificationCode(mutationArgs?: UseSendVerificationCodeMutationArgs): UseSendVerificationCodeResult

A custom hook to send OTP verification codes to email or SMS for account verification.

useSendVerificationCode
} from "@account-kit/react";
// First, send verification code const {
const sendVerificationCode: UseMutateFunction<void, Error, SendVerificationCodeParams, unknown>
sendVerificationCode
} =
function useSendVerificationCode(mutationArgs?: UseSendVerificationCodeMutationArgs): UseSendVerificationCodeResult

A custom hook to send OTP verification codes to email or SMS for account verification.

useSendVerificationCode
();
const {
const setEmail: UseMutateFunction<void, Error, SetEmailParams, unknown>
setEmail
,
const isSettingEmail: boolean
isSettingEmail
,
const error: Error | null
error
} =
function useSetEmail(mutationArgs?: UseSetEmailMutationArgs): UseSetEmailResult

A custom hook to set an email address for an already authenticated account.

Note: You should first use the useSendVerificationCode hook to send a verification code to the email address before calling this hook.

useSetEmail
({
onSuccess?: ((data: void, variables: SetEmailParams, onMutateResult: unknown, context: MutationFunctionContext) => Promise<unknown> | unknown) | undefined
onSuccess
: () => {
// do something when email is successfully set },
onError?: ((error: Error, variables: SetEmailParams, onMutateResult: unknown, context: MutationFunctionContext) => Promise<unknown> | unknown) | undefined
onError
: (
error: Error
error
) =>
var console: Console

The console module provides a simple debugging console that is similar to the JavaScript console mechanism provided by web browsers.

The module exports two specific components:

  • A Console class with methods such as console.log(), console.error() and console.warn() that can be used to write to any Node.js stream. * A global console instance configured to write to process.stdout and process.stderr. The global console can be used without importing the node:console module.

Warning: The global console object's methods are neither consistently synchronous like the browser APIs they resemble, nor are they consistently asynchronous like all other Node.js streams. See the note on process I/O for more information.

Example using the global console:


const name = 'Will Robinson'; console.warn(`Danger $name! Danger!`); // Prints: Danger Will Robinson! Danger!, to stderr ```

Example using the `Console` class:

```js const out = getStreamSomehow(); const err = getStreamSomehow(); const myConsole = new console.Console(out, err);

myConsole.log('hello world'); // Prints: hello world, to out myConsole.log('hello %s', 'world'); // Prints: hello world, to out myConsole.error(new Error('Whoops, something bad happened')); // Prints: [Error: Whoops, something bad happened], to err

const name = 'Will Robinson'; myConsole.warn(`Danger $name! Danger!`); // Prints: Danger Will Robinson! Danger!, to err ```
console
.
Console.error(message?: any, ...optionalParams: any[]): void (+2 overloads)

Prints to stderr with newline. Multiple arguments can be passed, with the first used as the primary message and all additional used as substitution values similar to printf(3) (the arguments are all passed to util.format()).

js const code = 5; console.error('error #%d', code); // Prints: error #5, to stderr console.error('error', code); // Prints: error 5, to stderr

If formatting elements (e.g. %d) are not found in the first string then util.inspect() is called on each argument and the resulting string values are concatenated. See util.format() for more information.

error
(
error: Error
error
),
}); // Step 1: Send verification code to email await
const sendVerificationCode: (variables: SendVerificationCodeParams, options?: MutateOptions<void, Error, SendVerificationCodeParams, unknown> | undefined) => void
sendVerificationCode
({
SendVerificationCodeParams.type: "email" | "sms"
type
: "email",
SendVerificationCodeParams.contact: string
contact
: "[email protected]",
}); // Step 2: Update email using verification code
const setEmail: (variables: SetEmailParams, options?: MutateOptions<void, Error, SetEmailParams, unknown> | undefined) => void
setEmail
({
verificationCode: string
verificationCode
: "123456", // code user received
}); // DEPRECATED: Use with just email string (for backward compatibility)
const setEmail: (variables: SetEmailParams, options?: MutateOptions<void, Error, SetEmailParams, unknown> | undefined) => void
setEmail
("[email protected]");

Parameters

ParameterTypeDescription

mutationArgs?

Partial<Omit<UseMutationOptions<void, Error, SetEmailParams, unknown>, "mutationFn" | "mutationKey">>

Optional arguments for the setEmail mutation

Returns

UseSetEmailResult

An object containing functions and state for setting the email