datasquirel/users/add-user.d.ts

29 lines
1.0 KiB
TypeScript
Raw Normal View History

2024-11-08 15:44:31 +00:00
export = addUser;
/**
* Add User to Database
2024-12-06 10:44:26 +00:00
* ============================================
2024-11-08 15:44:31 +00:00
* @async
*
2024-12-06 10:44:26 +00:00
* @param {object} param - Single object passed
* @param {string} param.key - FULL ACCESS API Key
* @param {string} param.database - Database Name
* @param {import("../package-shared/types").UserDataPayload} param.payload - User Data Payload
* @param {string} param.encryptionKey
* @param {string} [param.encryptionSalt]
* @param {string | number} [param.user_id]
* @param {string | number} param.apiUserId
* @param {boolean} [param.useLocal]
2024-11-08 15:44:31 +00:00
*
* @returns { Promise<import("../package-shared/types").AddUserFunctionReturn> }
*/
2024-12-06 10:44:26 +00:00
declare function addUser({ key, payload, database, encryptionKey, user_id, useLocal, apiUserId, }: {
2024-11-08 15:44:31 +00:00
key: string;
database: string;
payload: import("../package-shared/types").UserDataPayload;
encryptionKey: string;
encryptionSalt?: string;
2024-12-06 10:44:26 +00:00
user_id?: string | number;
apiUserId: string | number;
useLocal?: boolean;
2024-11-08 15:44:31 +00:00
}): Promise<import("../package-shared/types").AddUserFunctionReturn>;