UserMetadata Types

Type Aliases

APIInterface

type APIInterface = object;

Defined in: recipe/usermetadata/types.ts:39

RecipeInterface

type RecipeInterface = object;

Defined in: recipe/usermetadata/types.ts:41

Properties

Property	Type	Description	Defined in
clearUserMetadata	(input) => Promise<{ status: "OK"; }>	-	recipe/usermetadata/types.ts:60
getUserMetadata	(input) => Promise<{ metadata: any; status: "OK"; }>	-	recipe/usermetadata/types.ts:42
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:55

TypeInput

type TypeInput = object;

Defined in: recipe/usermetadata/types.ts:19

Properties

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

TypeNormalisedInput

type TypeNormalisedInput = object;

Defined in: recipe/usermetadata/types.ts:29

Properties

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