supertokens-node/recipe/usermetadata

References documentation for the supertokens-node/recipe/usermetadata package

Classes

default

Defined in: recipe/usermetadata/index.ts

Constructors

Constructor

new default(): default;

Returns

default

Properties

Methods

clearUserMetadata()

static clearUserMetadata(userId, userContext?): Promise<{
  status: "OK";
}>;

Defined in: recipe/usermetadata/index.ts

Parameters

Returns

Promise<{ status: "OK"; }>

getUserMetadata()

static getUserMetadata(userId, userContext?): Promise<{
  metadata: any;
  status: "OK";
}>;

Defined in: recipe/usermetadata/index.ts

Parameters

Returns

Promise<{ metadata: any; status: "OK"; }>

updateUserMetadata()

static updateUserMetadata(
   userId, 
   metadataUpdate, 
   userContext?): Promise<{
  metadata: JSONObject;
  status: "OK";
}>;

Defined in: recipe/usermetadata/index.ts

Parameters

Returns

Promise<{ metadata: JSONObject; status: "OK"; }>

Variables

clearUserMetadata()

const clearUserMetadata: (userId, userContext?) => Promise<{
  status: "OK";
}> = Wrapper.clearUserMetadata;

Defined in: recipe/usermetadata/index.ts

Parameters

Returns

Promise<{ status: "OK"; }>

getUserMetadata()

const getUserMetadata: (userId, userContext?) => Promise<{
  metadata: any;
  status: "OK";
}> = Wrapper.getUserMetadata;

Defined in: recipe/usermetadata/index.ts

Parameters

Returns

Promise<{ metadata: any; status: "OK"; }>

init()

const init: (config?) => RecipeListFunction = Wrapper.init;

Defined in: recipe/usermetadata/index.ts

Parameters

Returns

RecipeListFunction

updateUserMetadata()

const updateUserMetadata: (userId, metadataUpdate, userContext?) => Promise<{
  metadata: JSONObject;
  status: "OK";
}> = Wrapper.updateUserMetadata;

Defined in: recipe/usermetadata/index.ts

Parameters

Returns

Promise<{ metadata: JSONObject; status: "OK"; }>

References

JSONObject

Re-exports JSONObject

RecipeInterface

Re-exports RecipeInterface