datasquirel/users/get-user.d.ts

32 lines
1.5 KiB
TypeScript
Raw Permalink Normal View History

2024-12-06 10:35:59 +00:00
export = getUser;
/** ****************************************************************************** */
/** ****************************************************************************** */
/** ****************************************************************************** */
/** ****************************************************************************** */
/** ****************************************************************************** */
/** ****************************************************************************** */
/**
* ==============================================================================
* Main Function
* ==============================================================================
* @async
*
* @param {object} params - Single Param object containing params
* @param {String} params.key - API Key
* @param {String} params.database - Target Database
2024-12-11 04:24:58 +00:00
* @param {number} params.userId - user to get
2024-12-06 10:35:59 +00:00
* @param {string[]} [params.fields] - fields to select
2024-12-11 04:24:58 +00:00
* @param {boolean} [params.apiUserId] - API User ID
2024-12-06 10:35:59 +00:00
* @param {boolean} [params.useLocal] - Whether to use a remote database instead of API
*
* @returns { Promise<import("../package-shared/types").GetUserFunctionReturn>}
*/
2024-12-11 04:24:58 +00:00
declare function getUser({ key, userId, database, fields, apiUserId, useLocal }: {
2024-12-06 10:35:59 +00:00
key: string;
database: string;
userId: number;
fields?: string[];
2024-12-11 04:24:58 +00:00
apiUserId?: boolean;
2024-12-06 10:35:59 +00:00
useLocal?: boolean;
}): Promise<import("../package-shared/types").GetUserFunctionReturn>;