supertokens-supertokens-core

Namespace

supertokens-supertokens-core

Description:
  • Boost your app's security and user experience with SuperTokens' open-source auth solution. Integrate seamless login, multi-factor auth, and session management, all with no vendor lock-in.

Author:

Methods

(async, static) createSupertokensSupertokensCoreInstance(context, body) → {SupertokensSupertokensCore}

Description:
  • Create a new SuperTokens instance

Example
import { Context } from '@osaas/client-core';
import { createSupertokensSupertokensCoreInstance } from '@osaas/client-services';

const ctx = new Context();
const body: SupertokensSupertokensCoreConfig = { name: 'myinstance', ... };
const instance = await createSupertokensSupertokensCoreInstance(ctx, body);
console.log(instance.url);
Parameters:
Name Type Description
context Context

Open Source Cloud configuration context

body SupertokensSupertokensCoreConfig

Service instance configuration

Returns:
  • Service instance
Type
SupertokensSupertokensCore

(async, static) getSupertokensSupertokensCoreInstance(context, name) → {SupertokensSupertokensCore}

Description:
  • Get a SuperTokens instance

Example
import { Context } from '@osaas/client-core';
import { getSupertokensSupertokensCoreInstance } from '@osaas/client-services';

const ctx = new Context();
const instance = await getSupertokensSupertokensCoreInstance(ctx, 'myinstance');
console.log(instance.url);
Parameters:
Name Type Description
context Context

Open Source Cloud configuration context

name string

Name of the core to be retrieved

Returns:
  • Service instance
Type
SupertokensSupertokensCore

(async, static) removeSupertokensSupertokensCoreInstance(context, name)

Description:
  • Remove a SuperTokens instance

Parameters:
Name Type Description
context Context

Open Source Cloud configuration context

name string

Name of the core to be removed