fix typos

coinbase · Feb 12, 2024 · b79bf09 · b79bf09
1 parent 1801aaa
commit b79bf09
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -444,7 +444,7 @@ fetchUserAddress(3);
 // Fid - Farcaster Id
 fid: number;
 
-// Optional options to speicify whether the client wants custody and/or verified addresses
+// Optional options to specify whether the client wants custody and/or verified addresses
 // along with their neynar api key
 type GetFarcasterUserAddressOptions =
   | {

diff --git a/src/farcaster/getFarcasterUserAddress.ts b/src/farcaster/getFarcasterUserAddress.ts
@@ -13,8 +13,8 @@ type GetFarcasterUserAddressOptions =
 /**
  * Get the user address for a given fid
  * @param fid  The farcaster id
- * @param FarcasterAddressType represents whether the client wants a verified address or a custody address
- * @returns the validation addresses or the custory address. If there is an error, it returns null
+ * @param GetFarcasterUserAddressOptions  The options to specify the type of addresses to get and the neynar api key
+ * @returns the custory address and/or verified addresses. If there is an error, it returns null
  */
 async function getFarcasterUserAddress(
   fid: number,

diff --git a/src/farcaster/types.ts b/src/farcaster/types.ts
@@ -1,5 +1,5 @@
 /**
- * GetFarcasterUserAddressRequest
+ * GetFarcasterUserAddressResponse
  *
  * Note: exported as public Type
  */