useLogout
useLogoutフックは、ユーザーをログアウトさせてセッションを終了するためのメソッドを提供します。
基本的な使い方
import { useLogout } from 'authsafe-react';
function LogoutButton() {
const { logout } = useLogout();
return <button onClick={logout}>Logout</button>;
}戻り値
| 財産 | タイプ | 説明 |
|---|---|---|
logout | () => Promise<void> | ログアウトをトリガーする機能 |
isLoading | boolean | ログアウト操作が進行中かどうか |
error | Error | null | ログアウトに失敗した際のエラーオブジェクト |
ログアウト後のリダイレクト
ログアウト後にユーザーをリダイレクトする先を指定できます。
import { useLogout } from 'authsafe-react';
import { useNavigate } from 'react-router-dom';
function LogoutButton() {
const { logout, isLoading } = useLogout();
const navigate = useNavigate();
const handleLogout = async () => {
await logout();
navigate('/');
};
return (
<button onClick={handleLogout} disabled={isLoading}>
{isLoading ? 'Logging out...' : 'Logout'}
</button>
);
}型定義
interface IUseLogout {
logout: () => Promise<void>;
isLoading: boolean;
error: Error | null;
}