Function useAuth

Returns {
    login: ((params?) => Promise<void>);
    logout: ((params?) => void);
    refreshToken: ((refreshToken) => Promise<ErrorResponse | SessionResult>);
}

• login: ((params?) => Promise<void>)

  Initiates the authentication process.

  Example

  "use client";
  import { useAuth } from "@tailor-platform/auth/client";
  
  const Component = async () => {
    const { login } = useAuth();
    const doLogin = useCallback(() => {
      login({
        options: {
          redirectPath: "/dashboard",
        },
      });
    }, [login]);
  
    return (
      <div>
        <button onClick={doLogin}>Login</button>
      </div>
    );
  };
  Copy

  • • (params?): Promise<void>

    • Parameters

      • Optional params: LoginParams

      Returns Promise<void>

• logout: ((params?) => void)

  Signs out a user: deletes the session token and redirects to the specified page.

  Example

  "use client";
  import { useAuth } from "@tailor-platform/auth/client";
  
  const Component = async () => {
    const { logout } = useAuth();
  
    return (
      <div>
        <button onClick={() => logout()}>Logout</button>
      </div>
    );
  };
  Copy

  • • (params?): void

    • Parameters

      • Optional params: LogoutParams

      Returns void

• refreshToken: ((refreshToken) => Promise<ErrorResponse | SessionResult>)

  • • (refreshToken): Promise<ErrorResponse | SessionResult>

    • Parameters

      • refreshToken: string

      Returns Promise<ErrorResponse | SessionResult>