Skip to content
Esc
navigateopen⌘Jpreview
Dashboard
On this page

@supertokens-plugins/tenants-react

Public root exports for @supertokens-plugins/tenants-react 0.2.0.

Package version: 0.2.0

Generated from the packed release’s root declaration, ./dist/index.d.ts. Only exports reachable from that root are listed. See the immutable release source.

Public root exports

Export Kind
default Constant
init Constant
PLUGIN_ID Constant

default

Published from the emitted _default declaration.

Root export:

export default _default;

Resolved declaration:

declare const _default: {
    init: (config?: (import('./types').SuperTokensPluginTenantsPluginConfig & {
        override?: ((oI: undefined) => undefined) | undefined;
    }) | undefined) => import('supertokens-auth-react').SuperTokensPlugin;
    PLUGIN_ID: string;
};

init

Root export:

import { init } from './plugin';
import { PLUGIN_ID } from './constants';
export { init, PLUGIN_ID };

Resolved declaration:

import { SuperTokensPluginTenantsPluginConfig, SuperTokensPluginTenantsPluginNormalisedConfig, TranslationKeys } from './types';
import { SuperTokensPlugin, SuperTokensPublicConfig, SuperTokensPublicPlugin } from 'supertokens-auth-react';
export declare const init: (config?: (SuperTokensPluginTenantsPluginConfig & {
    override?: ((oI: undefined) => undefined) | undefined;
}) | undefined) => SuperTokensPlugin;

PLUGIN_ID

Root export:

import { init } from './plugin';
import { PLUGIN_ID } from './constants';
export { init, PLUGIN_ID };

Resolved declaration:

export declare const PLUGIN_ID = "supertokens-plugin-tenants";

Required signature types

These declarations are not additional package-root exports. They are included because the public signatures above depend on them.

SuperTokensPluginTenantsPluginConfig

export type SuperTokensPluginTenantsPluginConfig = {
    requireTenantCreation?: boolean;
    redirectToUrlOnJoiningTenant?: string | (() => void);
};

API reference

API schema and response details