supertokens-node/recipe/usermetadata/types

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

Type Aliases

type APIInterface = object;

type RecipeInterface = object;

Property	Type	Description	Defined in
`clearUserMetadata`	(`input`) => `Promise`<{ `status`: `"OK"`; }>	-	recipe/usermetadata/types.ts
`getUserMetadata`	(`input`) => `Promise`<{ `metadata`: `any`; `status`: `"OK"`; }>	-	recipe/usermetadata/types.ts
`updateUserMetadata`	(`input`) => `Promise`<{ `metadata`: `JSONObject`; `status`: `"OK"`; }>	Updates the metadata object of the user by doing a shallow merge of the stored and the update JSONs and removing properties set to null on the root level of the update object. e.g.: - stored: `{ "preferences": { "theme":"dark" }, "notifications": { "email": true }, "todos": ["example"] }` - update: `{ "notifications": { "sms": true }, "todos": null }` - result: `{ "preferences": { "theme":"dark" }, "notifications": { "sms": true } }`	recipe/usermetadata/types.ts

type TypeInput = object;

Property	Type	Defined in
`override?`	`object`	recipe/usermetadata/types.ts
`override.apis?`	(`originalImplementation`, `builder`) => `APIInterface`	recipe/usermetadata/types.ts
`override.functions?`	(`originalImplementation`, `builder`) => `RecipeInterface`	recipe/usermetadata/types.ts

type TypeNormalisedInput = object;

Property	Type	Defined in
`override`	`object`	recipe/usermetadata/types.ts
`override.apis`	(`originalImplementation`, `builder`) => `APIInterface`	recipe/usermetadata/types.ts
`override.functions`	(`originalImplementation`, `builder`) => `RecipeInterface`	recipe/usermetadata/types.ts