datasquirel/users/update-user.d.ts

26 lines
843 B
TypeScript
Raw Normal View History

2024-11-08 15:44:31 +00:00
export = updateUser;
/**
2024-12-06 10:44:26 +00:00
* # Update User
2024-11-08 15:44:31 +00:00
* @async
*
* @param {object} params - API Key
2024-12-08 08:58:57 +00:00
* @param {String} [params.key] - API Key
2024-11-08 15:44:31 +00:00
* @param {String} params.database - Target Database
2024-12-08 08:58:57 +00:00
* @param {String | number} params.updatedUserId - Target Database
* @param {Object.<string, any>} params.payload - User Object: ID is required
2024-12-06 10:44:26 +00:00
* @param {boolean} [params.user_id] - User ID
2024-12-06 11:55:03 +00:00
* @param {boolean} [params.useLocal]
2024-11-08 15:44:31 +00:00
*
* @returns { Promise<import("../package-shared/types").UpdateUserFunctionReturn>}
*/
2024-12-08 08:58:57 +00:00
declare function updateUser({ key, payload, database, user_id, useLocal, updatedUserId, }: {
key?: string;
2024-11-08 15:44:31 +00:00
database: string;
2024-12-08 08:58:57 +00:00
updatedUserId: string | number;
2024-11-08 15:44:31 +00:00
payload: {
[x: string]: any;
};
2024-12-06 10:44:26 +00:00
user_id?: boolean;
2024-12-06 11:55:03 +00:00
useLocal?: boolean;
2024-11-08 15:44:31 +00:00
}): Promise<import("../package-shared/types").UpdateUserFunctionReturn>;