supertokens-node/recipe/dashboard/types

References documentation for the supertokens-node/recipe/dashboard/types package

Type Aliases

APIFunction()

type APIFunction = (apiImplementation, tenantId, options, userContext) => Promise<any>;

Defined in: recipe/dashboard/types.ts

Parameters

Parameter	Type
`apiImplementation`	`APIInterface`
`tenantId`	`string`
`options`	`APIOptions`
`userContext`	`UserContext`

Returns

Promise<any>

APIInterface

type APIInterface = object;

Defined in: recipe/dashboard/types.ts

Properties

Property	Type	Defined in
`dashboardGET`	`undefined` \| (`input`) => `Promise`<`string`>	recipe/dashboard/types.ts

APIOptions

type APIOptions = object;

Defined in: recipe/dashboard/types.ts

Properties

Property	Type	Defined in
`appInfo`	`NormalisedAppinfo`	recipe/dashboard/types.ts
`config`	`TypeNormalisedInput`	recipe/dashboard/types.ts
`isInServerlessEnv`	`boolean`	recipe/dashboard/types.ts
`recipeId`	`string`	recipe/dashboard/types.ts
`recipeImplementation`	`RecipeInterface`	recipe/dashboard/types.ts
`req`	`BaseRequest`	recipe/dashboard/types.ts
`res`	`BaseResponse`	recipe/dashboard/types.ts

AuthMode

type AuthMode = "api-key" | "email-password";

Defined in: recipe/dashboard/types.ts

CoreConfigFieldInfo

type CoreConfigFieldInfo = object;

Defined in: recipe/dashboard/types.ts

Properties

Property	Type	Defined in
`defaultValue`	`string` \| `number` \| `boolean` \| `null`	recipe/dashboard/types.ts
`description`	`string`	recipe/dashboard/types.ts
`isDifferentAcrossTenants`	`boolean`	recipe/dashboard/types.ts
`isNullable`	`boolean`	recipe/dashboard/types.ts
`isPluginProperty`	`boolean`	recipe/dashboard/types.ts
`isPluginPropertyEditable`	`boolean`	recipe/dashboard/types.ts
`key`	`string`	recipe/dashboard/types.ts
`possibleValues?`	`string`[]	recipe/dashboard/types.ts
`value`	`string` \| `number` \| `boolean` \| `null`	recipe/dashboard/types.ts
`valueType`	`"string"` \| `"boolean"` \| `"number"`	recipe/dashboard/types.ts

RecipeIdForUser

type RecipeIdForUser = "emailpassword" | "thirdparty" | "passwordless" | "webauthn";

Defined in: recipe/dashboard/types.ts

RecipeInterface

type RecipeInterface = object;

Defined in: recipe/dashboard/types.ts

Methods

getDashboardBundleLocation()

getDashboardBundleLocation(input): Promise<string>;

Defined in: recipe/dashboard/types.ts

Parameters

Parameter	Type
`input`	{ `userContext`: `UserContext`; }
`input.userContext`	`UserContext`

Returns

Promise<string>

shouldAllowAccess()

shouldAllowAccess(input): Promise<boolean>;

Defined in: recipe/dashboard/types.ts

Parameters

Parameter	Type
`input`	{ `config`: `TypeNormalisedInput`; `req`: `BaseRequest`; `userContext`: `UserContext`; }
`input.config`	`TypeNormalisedInput`
`input.req`	`BaseRequest`
`input.userContext`	`UserContext`

Returns

Promise<boolean>

TypeInput

type TypeInput = object;

Defined in: recipe/dashboard/types.ts

Properties

Property	Type	Defined in
`admins?`	`string`[]	recipe/dashboard/types.ts
`apiKey?`	`string`	recipe/dashboard/types.ts
`override?`	`object`	recipe/dashboard/types.ts
`override.apis?`	(`originalImplementation`, `builder`) => `APIInterface`	recipe/dashboard/types.ts
`override.functions?`	(`originalImplementation`, `builder`) => `RecipeInterface`	recipe/dashboard/types.ts

TypeNormalisedInput

type TypeNormalisedInput = object;

Defined in: recipe/dashboard/types.ts

Properties

Property	Type	Defined in
`admins?`	`string`[]	recipe/dashboard/types.ts
`apiKey?`	`string`	recipe/dashboard/types.ts
`authMode`	`AuthMode`	recipe/dashboard/types.ts
`override`	`object`	recipe/dashboard/types.ts
`override.apis`	(`originalImplementation`, `builder`) => `APIInterface`	recipe/dashboard/types.ts
`override.functions`	(`originalImplementation`, `builder`) => `RecipeInterface`	recipe/dashboard/types.ts

UserWithFirstAndLastName

type UserWithFirstAndLastName = User & object;

Defined in: recipe/dashboard/types.ts

Type Declaration

Name	Type	Defined in
`firstName?`	`string`	recipe/dashboard/types.ts
`lastName?`	`string`	recipe/dashboard/types.ts