SuperTokens React

Classes

default

Defined in: index.ts:33

Constructors

Constructor

new default(): default;

Returns

default

Properties

Property	Modifier	Type	Default value	Defined in
getTranslationFunction	static	<T>(...stores) => (key, replacements?) => string	getTranslationFunction	index.ts:70
SuperTokensWrapper	static	any	SuperTokensWrapper	index.ts:34
useTranslation	static	any	useTranslation	index.ts:68
useUserContext	static	any	useUserContext	index.ts:72

Methods

changeLanguage()

static changeLanguage(language): Promise<void>;

Defined in: index.ts:40

Parameters

Parameter	Type
language	string

Returns

Promise<void>

init()

static init(config): void;

Defined in: index.ts:36

Parameters

Parameter	Type
config	SuperTokensConfig

Returns

void

isRecipeInitialized()

static isRecipeInitialized(recipeId): any;

Defined in: index.ts:62

Parameters

Parameter	Type
recipeId	string

Returns

any

loadTranslation()

static loadTranslation(store): void;

Defined in: index.ts:44

Parameters

Parameter	Type
store	TranslationStore

Returns

void

redirectToAuth()

static redirectToAuth(options?): Promise<any>;

Defined in: index.ts:48

Parameters

Parameter	Type
options?	{ navigate?: Navigate; queryParams?: any; redirectBack?: boolean; show?: "signin" | "signup"; userContext?: UserContext; }
options.navigate?	Navigate
options.queryParams?	any
options.redirectBack?	boolean
options.show?	"signin" | "signup"
options.userContext?	UserContext

Returns

Promise<any>

Type Aliases

TranslationStore

type TranslationStore = Record<string, Record<string, string | undefined>>;

Defined in: translation/translationHelpers.ts:7

Variables

changeLanguage()

const changeLanguage: (language) => Promise<void> = SuperTokensAPIWrapper.changeLanguage;

Defined in: index.ts:76

Parameters

Parameter	Type
language	string

Returns

Promise<void>

init()

const init: (config) => void = SuperTokensAPIWrapper.init;

Defined in: index.ts:75

Parameters

Parameter	Type
config	SuperTokensConfig

Returns

void

isRecipeInitialized()

const isRecipeInitialized: (recipeId) => any = SuperTokensAPIWrapper.isRecipeInitialized;

Defined in: index.ts:79

Parameters

Parameter	Type
recipeId	string

Returns

any

loadTranslation()

const loadTranslation: (store) => void = SuperTokensAPIWrapper.loadTranslation;

Defined in: index.ts:77

Parameters

Parameter	Type
store	TranslationStore

Returns

void

redirectToAuth()

const redirectToAuth: (options?) => Promise<any> = SuperTokensAPIWrapper.redirectToAuth;

Defined in: index.ts:78

Parameters

Parameter	Type
options?	{ navigate?: Navigate; queryParams?: any; redirectBack?: boolean; show?: "signin" | "signup"; userContext?: UserContext; }
options.navigate?	Navigate
options.queryParams?	any
options.redirectBack?	boolean
options.show?	"signin" | "signup"
options.userContext?	UserContext

Returns

Promise<any>

SuperTokensWrapper

SuperTokensWrapper: any;

Functions

getTranslationFunction()

function getTranslationFunction<T>(...stores): (key, replacements?) => string;

Defined in: translation/translationHelpers.ts:77

Type Parameters

Type Parameter
T extends string

Parameters

Parameter	Type
...stores	TranslationStore[]

Returns

(key, replacements?): string;

Parameters

Parameter	Type
key	T
replacements?	Record<string, string>

Returns

string

References

SuperTokensConfig

Re-exports SuperTokensConfig

SuperTokensPlugin

Re-exports SuperTokensPlugin

SuperTokensPublicConfig

Re-exports SuperTokensPublicConfig

SuperTokensPublicPlugin

Re-exports SuperTokensPublicPlugin

useTranslation

Renames and re-exports SuperTokensWrapper

useUserContext

Renames and re-exports SuperTokensWrapper