Function: getUserProperty()

function getUserProperty(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  key?: string;
  value?: unknown;
}>;

Defined in: src/server/api/users.ts:697

Returns the value of the property with a given key from the user identified by the key or by the id.

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ propertyKey: string; userKey?: string; username?: string; }	-
parameters.propertyKey	string	The key of the user's property
parameters.userKey?	string	Key of the user whose property is to be returned
parameters.username?	string	Username of the user whose property is to be returned
options?	RequestOptions	-

Returns

Promise<{ [key: string]: unknown; key?: string; value?: unknown; }>