refactor(docs): adds documentation to hooks

Author: bdbch

src/lib/useArticles.ts

@@ -2,6 +2,12 @@ import { useEffect, useState } from "react";
 
 import { IArticlesResponse, IPost } from "..";
 
+/**
+ * Returns a list of articles
+ * @param page filter articles by pagination
+ * @param tag filter articles by tag
+ * @param username receive articles by username
+ */
 export default function useArticles(
   page?: string,
   tag?: string,

src/lib/useFollowSuggestions.ts

@@ -2,6 +2,9 @@ import { useEffect, useState } from "react";
 
 import { IFollowSuggestionsResponse, IUser } from "..";
 
+/**
+ * returns follow suggestions for new users
+ */
 export default function useFollowSuggestions(): IFollowSuggestionsResponse {
   const [suggestions, setSuggestions] = useState<IUser[]>([]);
   const [loading, setLoading] = useState(false);

src/lib/useTags.ts

@@ -2,6 +2,10 @@ import { useEffect, useState } from "react";
 
 import { ITag, ITagsResponse } from "..";
 
+/**
+ * returns a list of tags
+ * @param page filter by pagination
+ */
 export default function useTags(page?: number): ITagsResponse {
   const [tags, setTags] = useState<ITag[]>([]);
   const [loading, setLoading] = useState(false);

src/lib/useUser.ts

@@ -2,6 +2,11 @@ import { useCallback, useState } from "react";
 
 import { IUser, IUserResponse } from "..";
 
+/**
+ * returns a dev.to user by either the username or id
+ * @param username the users username
+ * @param id the users id
+ */
 export default function useUser(username?: string, id?: string): IUserResponse {
   const [user, setUser] = useState<IUser | undefined>();
   const [loading, setLoading] = useState(false);