TOTP

Classes

default

Defined in: recipe/totp/index.ts:31

Constructors

Constructor

new default(): default;

Returns

default

Properties

Property	Modifier	Type	Default value	Defined in
ComponentsOverrideProvider	static	any	RecipeComponentsOverrideContextProvider	recipe/totp/index.ts:71

Methods

createDevice()

static createDevice(input?): any;

Defined in: recipe/totp/index.ts:35

Parameters

Parameter	Type
input?	{ deviceName?: string; options?: RecipeFunctionOptions; userContext?: UserContext; }
input.deviceName?	string
input.options?	RecipeFunctionOptions
input.userContext?	UserContext

Returns

any

init()

static init(config?): any;

Defined in: recipe/totp/index.ts:32

Parameters

Parameter	Type
config?	UserInput

Returns

any

listDevices()

static listDevices(input?): any;

Defined in: recipe/totp/index.ts:64

Parameters

Parameter	Type
input?	{ options?: RecipeFunctionOptions; userContext?: UserContext; }
input.options?	RecipeFunctionOptions
input.userContext?	UserContext

Returns

any

removeDevice()

static removeDevice(input): any;

Defined in: recipe/totp/index.ts:58

Parameters

Parameter	Type
input	{ deviceName: string; options?: RecipeFunctionOptions; userContext?: UserContext; }
input.deviceName	string
input.options?	RecipeFunctionOptions
input.userContext?	UserContext

Returns

any

verifyCode()

static verifyCode(input): any;

Defined in: recipe/totp/index.ts:41

Parameters

Parameter	Type
input	{ options?: RecipeFunctionOptions; totp: string; userContext?: UserContext; }
input.options?	RecipeFunctionOptions
input.totp	string
input.userContext?	UserContext

Returns

any

verifyDevice()

static verifyDevice(input): any;

Defined in: recipe/totp/index.ts:47

Parameters

Parameter	Type
input	{ deviceName: string; options?: any; totp: string; userContext?: UserContext; }
input.deviceName	string
input.options?	any
input.totp	string
input.userContext?	UserContext

Returns

any

Variables

createDevice()

const createDevice: (input?) => any = Wrapper.createDevice;

Defined in: recipe/totp/index.ts:75

Parameters

Parameter	Type
input?	{ deviceName?: string; options?: RecipeFunctionOptions; userContext?: UserContext; }
input.deviceName?	string
input.options?	RecipeFunctionOptions
input.userContext?	UserContext

Returns

any

init()

const init: (config?) => any = Wrapper.init;

Defined in: recipe/totp/index.ts:74

Parameters

Parameter	Type
config?	UserInput

Returns

any

listDevices()

const listDevices: (input?) => any = Wrapper.listDevices;

Defined in: recipe/totp/index.ts:79

Parameters

Parameter	Type
input?	{ options?: RecipeFunctionOptions; userContext?: UserContext; }
input.options?	RecipeFunctionOptions
input.userContext?	UserContext

Returns

any

removeDevice()

const removeDevice: (input) => any = Wrapper.removeDevice;

Defined in: recipe/totp/index.ts:78

Parameters

Parameter	Type
input	{ deviceName: string; options?: RecipeFunctionOptions; userContext?: UserContext; }
input.deviceName	string
input.options?	RecipeFunctionOptions
input.userContext?	UserContext

Returns

any

TOTPComponentsOverrideProvider

const TOTPComponentsOverrideProvider: any = Wrapper.ComponentsOverrideProvider;

Defined in: recipe/totp/index.ts:80

verifyCode()

const verifyCode: (input) => any = Wrapper.verifyCode;

Defined in: recipe/totp/index.ts:76

Parameters

Parameter	Type
input	{ options?: RecipeFunctionOptions; totp: string; userContext?: UserContext; }
input.options?	RecipeFunctionOptions
input.totp	string
input.userContext?	UserContext

Returns

any

verifyDevice()

const verifyDevice: (input) => any = Wrapper.verifyDevice;

Defined in: recipe/totp/index.ts:77

Parameters

Parameter	Type
input	{ deviceName: string; options?: any; totp: string; userContext?: UserContext; }
input.deviceName	string
input.options?	any
input.totp	string
input.userContext?	UserContext

Returns

any

References

GetRedirectionURLContext

Re-exports GetRedirectionURLContext

OnHandleEventContext

Re-exports OnHandleEventContext

PreAPIHookContext

Re-exports PreAPIHookContext

RecipeInterface

Renames and re-exports SuperTokensWrapper

UserInput

Re-exports UserInput