SuperTokens Node Types

Interfaces

HttpRequest

Defined in: types.ts:197

Properties

Property	Type	Defined in
body?	any	types.ts:202
headers	object	types.ts:200
method	HTTPMethod	types.ts:199
params?	Record<string, boolean | number | string | undefined>	types.ts:201
url	string	types.ts:198

JSONObject

Defined in: types.ts:223

Indexable

[ind: string]: JSONValue

Type Aliases

AllRecipeConfigs

type AllRecipeConfigs = object;

Defined in: types.ts:90

Properties

Property	Type	Defined in
accountlinking	TypeInput & object	types.ts:91
dashboard	TypeInput	types.ts:92
emailpassword	TypeInput	types.ts:93
emailverification	TypeInput	types.ts:94
jwt	TypeInput	types.ts:95
multifactorauth	TypeInput	types.ts:96
multitenancy	TypeInput	types.ts:97
oauth2provider	TypeInput	types.ts:98
openid	TypeInput	types.ts:99
passwordless	TypeInput	types.ts:100
session	SessionTypeInput	types.ts:101
thirdparty	TypeInput	types.ts:102
totp	TypeInput	types.ts:103
usermetadata	TypeInput	types.ts:104
userroles	TypeInput	types.ts:105
webauthn	TypeInput	types.ts:106

APIHandled

type APIHandled = object;

Defined in: types.ts:211

Properties

Property	Type	Defined in
disabled	boolean	types.ts:215
id	string	types.ts:214
method	HTTPMethod	types.ts:213
pathWithoutApiBasePath	NormalisedURLPath	types.ts:212

AppInfo

type AppInfo = object;

Defined in: types.ts:62

Properties

Property	Type	Defined in
apiBasePath?	string	types.ts:68
apiDomain	string	types.ts:67
apiGatewayPath?	string	types.ts:69
appName	string	types.ts:63
origin?	string | (input) => string	types.ts:65
websiteBasePath?	string	types.ts:66
websiteDomain?	string	types.ts:64

Entries<T>

type Entries<T> = { [K in keyof T]-?: [K, T[K]] }[keyof T][];

Defined in: types.ts:53

Type Parameters

Type Parameter
T

GeneralErrorResponse

type GeneralErrorResponse = object;

Defined in: types.ts:226

Properties

Property	Type	Defined in
message	string	types.ts:228
status	"GENERAL_ERROR"	types.ts:227

HTTPMethod

type HTTPMethod = "post" | "get" | "delete" | "put" | "patch" | "options" | "trace";

Defined in: types.ts:218

JSONArray

type JSONArray = JSONValue[];

Defined in: types.ts:221

JSONPrimitive

type JSONPrimitive = string | number | boolean | null;

Defined in: types.ts:220

JSONValue

type JSONValue = 
  | JSONPrimitive
  | JSONObject
  | JSONArray
  | undefined;

Defined in: types.ts:222

NetworkInterceptor()

type NetworkInterceptor = (request, userContext) => HttpRequest;

Defined in: types.ts:195

Parameters

Parameter	Type
request	HttpRequest
userContext	UserContext

Returns

HttpRequest

NonNullableProperties<T>

type NonNullableProperties<T> = { [P in keyof T]: NonNullable<T[P]> };

Defined in: types.ts:49

Type Parameters

Type Parameter
T

NonPublicConfigPropertiesType

type NonPublicConfigPropertiesType = typeof nonPublicConfigProperties[number];

Defined in: types.ts:163

NormalisedAppinfo

type NormalisedAppinfo = object;

Defined in: types.ts:72

Properties

Property	Type	Defined in
apiBasePath	NormalisedURLPath	types.ts:78
apiDomain	NormalisedURLDomain	types.ts:75
apiGatewayPath	NormalisedURLPath	types.ts:79
appName	string	types.ts:73
getOrigin	(input) => NormalisedURLDomain	types.ts:74
getTopLevelWebsiteDomain	(input) => string	types.ts:77
topLevelAPIDomain	string	types.ts:76
websiteBasePath	NormalisedURLPath	types.ts:80

PluginRouteHandler

type PluginRouteHandler = object;

Defined in: types.ts:115

Properties

Property	Type	Defined in
handler	(req, res, session, userContext) => Promise< | { body: JSONObject; status: number; } | null>	types.ts:119
method	HTTPMethod	types.ts:116
path	string	types.ts:117
verifySessionOptions?	VerifySessionOptions	types.ts:118

RecipeListFunction()

type RecipeListFunction = (appInfo, isInServerlessEnv, overrideMaps) => RecipeModule;

Defined in: types.ts:205

Parameters

Parameter	Type
appInfo	NormalisedAppinfo
isInServerlessEnv	boolean
overrideMaps	NonNullable<SuperTokensPlugin["overrideMap"]>[]

Returns

RecipeModule

RecipePluginOverride<T>

type RecipePluginOverride<T> = object;

Defined in: types.ts:109

Type Parameters

Type Parameter
T extends keyof AllRecipeConfigs

Properties

Property	Type	Defined in
apis?	NonNullable<AllRecipeConfigs[T]["override"]>["apis"]	types.ts:111
config?	(config) => AllRecipeConfigs[T]	types.ts:112
functions?	NonNullable<AllRecipeConfigs[T]["override"]>["functions"]	types.ts:110

SuperTokensConfigWithNormalisedAppInfo

type SuperTokensConfigWithNormalisedAppInfo = Omit<TypeInput, "appInfo"> & object;

Defined in: types.ts:165

Type Declaration

Name	Type	Defined in
appInfo	NormalisedAppinfo	types.ts:166

SuperTokensInfo

type SuperTokensInfo = object;

Defined in: types.ts:83

Properties

Property	Type	Defined in
apiKey?	string	types.ts:85
connectionURI	string	types.ts:84
disableCoreCallCache?	boolean	types.ts:87
networkInterceptor?	NetworkInterceptor	types.ts:86

SuperTokensPlugin

type SuperTokensPlugin = object;

Defined in: types.ts:130

Properties

Property	Type	Defined in
compatibleSDKVersions?	string | string[]	types.ts:133
config?	(config) => | Omit<SuperTokensPublicConfig, "appInfo"> | undefined	types.ts:152
dependencies?	(config, pluginsAbove, sdkVersion) => | { pluginsToAdd?: SuperTokensPlugin[]; status: "OK"; } | { message: string; status: "ERROR"; }	types.ts:135
exports?	Record<string, any>	types.ts:153
id	string	types.ts:131
init?	(config, allPlugins, sdkVersion) => void	types.ts:134
overrideMap?	{ [recipeId in keyof AllRecipeConfigs]?: RecipePluginOverride<recipeId> & { recipeInitRequired?: boolean | ((sdkVersion: string) => boolean) } }	types.ts:140
routeHandlers?	| (config, allPlugins, sdkVersion) => | { routeHandlers: PluginRouteHandler[]; status: "OK"; } | { message: string; status: "ERROR"; } | PluginRouteHandler[]	types.ts:145
version?	string	types.ts:132

SuperTokensPublicConfig

type SuperTokensPublicConfig = Omit<Omit<TypeInput, NonPublicConfigPropertiesType>, "appInfo"> & object;

Defined in: types.ts:169

Type Declaration

Name	Type	Defined in
appInfo	NormalisedAppinfo	types.ts:170

SuperTokensPublicPlugin

type SuperTokensPublicPlugin = Pick<SuperTokensPlugin, "id" | "version" | "compatibleSDKVersions" | "exports"> & object;

Defined in: types.ts:156

Type Declaration

Name	Type	Defined in
initialized	boolean	types.ts:159

TypeInput

type TypeInput = object;

Defined in: types.ts:173

Properties

Property	Type	Description	Defined in
appInfo	AppInfo	-	types.ts:176
debug?	boolean	-	types.ts:180
experimental?	object	Our experimental features are not yet stable and are subject to change. In practical terms, this means that their interface is subject to change without a major version update. They are also not tested as much as our "normal" features. If you want to use these features, or if you have any feedback please let us know at: https://supertokens.com/discord	types.ts:190
experimental.plugins?	SuperTokensPlugin[]	-	types.ts:191
framework?	TypeFramework	-	types.ts:175
isInServerlessEnv?	boolean	-	types.ts:179
recipeList	RecipeListFunction[]	-	types.ts:177
supertokens?	SuperTokensInfo	-	types.ts:174
telemetry?	boolean	-	types.ts:178

User

type User = object;

Defined in: types.ts:231

Properties

Property	Type	Defined in
emails	string[]	types.ts:236
id	string	types.ts:232
isPrimaryUser	boolean	types.ts:234
loginMethods	RecipeLevelUser & object[]	types.ts:245
phoneNumbers	string[]	types.ts:237
tenantIds	string[]	types.ts:235
thirdParty	object[]	types.ts:238
timeJoined	number	types.ts:233
toJson	() => any	types.ts:257
webauthn	object	types.ts:242
webauthn.credentialIds	string[]	types.ts:243

UserContext

type UserContext = Branded<Record<string, any>, "UserContext">;

Defined in: types.ts:60

Variables

nonPublicConfigProperties

const nonPublicConfigProperties: readonly ["recipeList", "experimental"];

Defined in: types.ts:161