useSetEmail
Defined in: account-kit/react/dist/types/hooks/useSetEmail.d.ts:55
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): UseSetEmailResultA custom hook to handle setting an email for an already authenticated account, which includes executing a mutation with optional parameters.
useSetEmail, import useSendVerificationCodeuseSendVerificationCode } from "@account-kit/react";
// First, send verification code
const { const sendVerificationCode: anysendVerificationCode } = import useSendVerificationCodeuseSendVerificationCode();
const { const setEmail: UseMutateFunction<void, Error, string, unknown>setEmail, const isSettingEmail: booleanisSettingEmail, const error: Error | nullerror } = function useSetEmail(mutationArgs?: UseSetEmailMutationArgs): UseSetEmailResultA custom hook to handle setting an email for an already authenticated account, which includes executing a mutation with optional parameters.
useSetEmail({
onSuccess?: ((data: void, variables: string, context: unknown) => Promise<unknown> | unknown) | undefinedonSuccess: () => {
// do something when email is successfully set
},
onError?: ((error: Error, variables: string, context: unknown) => Promise<unknown> | unknown) | undefinedonError: (error: Errorerror) => var console: ConsoleThe 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: Errorerror),
});
// Step 1: Send verification code to email
await const sendVerificationCode: anysendVerificationCode({
type: stringtype: "email",
contact: stringcontact: "[email protected]",
});
// Step 2: Update email using verification code
const setEmail: (variables: string, options?: MutateOptions<void, Error, string, unknown> | undefined) => voidsetEmail({
verificationCode: stringverificationCode: "123456", // code user received
});
// DEPRECATED: Use with just email string (for backward compatibility)
const setEmail: (variables: string, options?: MutateOptions<void, Error, string, unknown> | undefined) => voidsetEmail("[email protected]");Parameters
Returns
An object containing functions and state for setting the email