supertokens-web-js/recipe/multifactorauth/types

References documentation for the supertokens-web-js/recipe/multifactorauth/types package

Type Aliases

type InputType = AuthRecipeInputType<PreAndPostAPIHookAction> & UserInput;

type MFAClaimValue = object;

Property	Type	Defined in
`c`	`Record`<`string`, `number` \| `undefined`>	tmp/supertokens-web-js/lib/ts/recipe/multifactorauth/types.ts
`v`	`boolean`	tmp/supertokens-web-js/lib/ts/recipe/multifactorauth/types.ts

type MFAFactorInfo = object;

Property	Type	Defined in
`allowedToSetup`	`string`[]	tmp/supertokens-web-js/lib/ts/recipe/multifactorauth/types.ts
`alreadySetup`	`string`[]	tmp/supertokens-web-js/lib/ts/recipe/multifactorauth/types.ts
`next`	`string`[]	tmp/supertokens-web-js/lib/ts/recipe/multifactorauth/types.ts

type MFARequirement = string;

type MFARequirementList = (
  | {
  oneOf: MFARequirement[];
}
  | {
  allOfInAnyOrder: MFARequirement[];
}
  | MFARequirement)[];

type NormalisedInputType = AuthRecipeNormalisedInputType<PreAndPostAPIHookAction> & object;

Name	Type	Defined in
`override`	`object`	tmp/supertokens-web-js/lib/ts/recipe/multifactorauth/types.ts
`override.functions()`	(`originalImplementation`, `builder`) => `RecipeInterface`	tmp/supertokens-web-js/lib/ts/recipe/multifactorauth/types.ts

type PostAPIHookContext = RecipePostAPIHookContext<PreAndPostAPIHookAction>;

type PreAndPostAPIHookAction = "GET_MFA_INFO";

type PreAPIHookContext = RecipePreAPIHookContext<PreAndPostAPIHookAction>;

type RecipeInterface = object;

Property	Type	Defined in
`resyncSessionAndFetchMFAInfo`	(`input`) => `Promise`<{ `emails`: `Record`<`string`, `string`[] \| `undefined`>; `factors`: `MFAFactorInfo`; `fetchResponse`: `Response`; `phoneNumbers`: `Record`<`string`, `string`[] \| `undefined`>; `status`: `"OK"`; }>	tmp/supertokens-web-js/lib/ts/recipe/multifactorauth/types.ts

type UserInput = object & RecipeModuleUserInput<PreAndPostAPIHookAction>;

Name	Type	Defined in
`override?`	`object`	tmp/supertokens-web-js/lib/ts/recipe/multifactorauth/types.ts
`override.functions()?`	(`originalImplementation`, `builder`) => `RecipeInterface`	tmp/supertokens-web-js/lib/ts/recipe/multifactorauth/types.ts