docs: update docs

alchemyplatform · Apr 17, 2024 · fb55de7 · fb55de7
1 parent 94f4429
commit fb55de7
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 11 deletions.
diff --git a/packages/alchemy/src/react/hooks/useLogout.ts b/packages/alchemy/src/react/hooks/useLogout.ts
@@ -5,17 +5,10 @@ import { useAlchemyAccountContext } from "../context.js";
 import type { BaseHookMutationArgs } from "../types.js";
 import { useSigner } from "./useSigner.js";
 
-export type UseLogoutData = void;
-
-export type UseLogoutParams = void;
-
-export type UseLogoutMutationArgs = BaseHookMutationArgs<
-  UseLogoutData,
-  UseLogoutParams
->;
+export type UseLogoutMutationArgs = BaseHookMutationArgs<void, void>;
 
 export type UseLogoutResult = {
-  logout: UseMutateFunction<UseLogoutData, Error, UseLogoutParams, unknown>;
+  logout: UseMutateFunction<void, Error, void, unknown>;
   isLoggingOut: boolean;
   error: Error | null;
 };

diff --git a/site/snippets/react/useAddPasskey.tsx b/site/snippets/react/useAddPasskey.tsx
@@ -1,7 +1,10 @@
 import { useAddPasskey } from "@alchemy/aa-alchemy/react";
 
 export function ComponentWithAddPasskey() {
-  // Assumes the app has context of a signer with an authenticated user
+  /**
+   * Assumes the app has context of a signer with an authenticated user
+   * by using the `AlchemyAccountProvider` from `@alchemy/aa-alchemy/react`.
+   */
   const addPasskey = useAddPasskey();
 
   return (

diff --git a/site/snippets/react/useLogout.tsx b/site/snippets/react/useLogout.tsx
@@ -1,7 +1,10 @@
 import { useLogout } from "@alchemy/aa-alchemy/react";
 
 export function ComponentWithLogout() {
-  // Assumes the app has context of a signer with an authenticated user
+  /**
+   * Assumes the app has context of a signer with an authenticated user
+   * by using the `AlchemyAccountProvider` from `@alchemy/aa-alchemy/react`.
+   */
   const { logout } = useLogout();
 
   return (