if-follow-package/if-follow-package.d.ts

if-follow-package is a JavaScript library that provides APIs for managing followers and followings on GitHub. This package allows you to find users who are not following you back, find users who are following you back, unfollow users who are not following

interface IfFollow {
  isFollower(username: string): Promise<boolean>;
  isFollowing(username: string): Promise<boolean>;
  totalFollowers(): Promise<number>;
  totalFollowings(): Promise<number>;
  whoNotFollowingBack(): Promise<string[]>;
  whoFollowingBack(): Promise<string[]>;
  isFollowingBack(username: string): Promise<boolean>;
  unfollowNotFollowingBack(username: string): Promise<void>;
  unfollowAllNotFollowingBack(): Promise<void>;
}

/**
 * Creates an instance of the IfFollow type.
 *
 * @param yourUsername - Your GitHub username.
 * @param yourToken - Your GitHub personal access token.
 * @returns {IfFollow} An object to manage followers and followings.
 */
declare function ifFollow(yourUsername: string, yourToken: string): IfFollow;

export = ifFollow;