mtcute/packages/client/src/methods/auth/log-out.ts
2021-04-08 12:19:38 +03:00

25 lines
607 B
TypeScript

import { TelegramClient } from '../../client'
/**
* Log out from Telegram account and optionally reset the session storage.
*
* When you log out, you can immediately log back in using
* the same {@link TelegramClient} instance.
*
* @param resetSession Whether to reset the session
* @returns On success, `true` is returned
* @internal
*/
export async function logOut(
this: TelegramClient,
resetSession = false
): Promise<true> {
await this.call({ _: 'auth.logOut' })
if (resetSession) {
this.storage.reset()
await this.storage.save?.()
}
return true
}