From b79bf09319cf37b7cdef8d985bdaecec21a87f13 Mon Sep 17 00:00:00 2001 From: Sneh1999 Date: Tue, 13 Feb 2024 02:24:51 +0530 Subject: [PATCH] fix typos --- README.md | 2 +- src/farcaster/getFarcasterUserAddress.ts | 4 ++-- src/farcaster/types.ts | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 179529920b..e76c72be88 100644 --- 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 index a31c94f396..089f9ca4e2 100644 --- 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 index 84c80c6ea1..580ac856d4 100644 --- a/src/farcaster/types.ts +++ b/src/farcaster/types.ts @@ -1,5 +1,5 @@ /** - * GetFarcasterUserAddressRequest + * GetFarcasterUserAddressResponse * * Note: exported as public Type */