useSendVerificationCode
Defined in: account-kit/react/src/hooks/useSendVerificationCode.ts:74
A custom hook to send OTP verification codes to email or SMS for account verification.
Example
import { function useSendVerificationCode(mutationArgs?: UseSendVerificationCodeMutationArgs): UseSendVerificationCodeResultA custom hook to send OTP verification codes to email or SMS for account verification.
useSendVerificationCode } from "@account-kit/react";
const { const sendVerificationCode: UseMutateFunction<void, Error, SendVerificationCodeParams, unknown>sendVerificationCode, const isSendingCode: booleanisSendingCode, const error: Error | nullerror } = function useSendVerificationCode(mutationArgs?: UseSendVerificationCodeMutationArgs): UseSendVerificationCodeResultA custom hook to send OTP verification codes to email or SMS for account verification.
useSendVerificationCode({
onSuccess?: ((data: void, variables: SendVerificationCodeParams, onMutateResult: unknown, context: MutationFunctionContext) => Promise<unknown> | unknown) | undefinedonSuccess: (data: voiddata) => {
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.log(message?: any, ...optionalParams: any[]): void (+2 overloads)Prints to stdout
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 count = 5; console.log('count: %d', count); // Prints: count: 5, to stdout console.log('count:', count); // Prints: count: 5, to stdout
See util.format()
for more information.
log("OTP sent");
},
onError?: ((error: Error, variables: SendVerificationCodeParams, onMutateResult: unknown, context: MutationFunctionContext) => 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),
});
// Send verification code to email
const sendVerificationCode: (variables: SendVerificationCodeParams, options?: MutateOptions<void, Error, SendVerificationCodeParams, unknown> | undefined) => voidsendVerificationCode({
SendVerificationCodeParams.type: "email" | "sms"type: "email",
SendVerificationCodeParams.contact: stringcontact: "[email protected]",
});
// Send verification code to SMS
anysendVerificationCodeAsync({
type: stringtype: "sms",
contact: stringcontact: "+1234567890",
});
Parameters
Returns
An object containing functions and state for sending verification codes