Skip to content

Function: getUserPropertyKeys() ​

ts
function getUserPropertyKeys(
   client, 
   parameters?, 
   options?
): Promise<{
[key: string]: unknown;
  keys?: object[];
}>;

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

Returns the keys of all properties for the user identified by the key or by the id.

Parameters ​

ParameterTypeDescription
clientClient-
parameters?{ userKey?: string; username?: string; }-
parameters.userKey?stringKey of the user whose properties are to be returned
parameters.username?stringUsername of the user whose properties are to be returned
options?RequestOptions-

Returns ​

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