if-follow-package
Version:
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
35 lines (31 loc) • 1.59 kB
JavaScript
/**
* Type for managing followers and followings on GitHub.
*
* @typedef {Object} IfFollow
* @property {Function} isFollower - Checks if a user is following the authenticated user.
* @property {Function} isFollowing - Checks if the authenticated user is following a given user.
* @property {Function} totalFollowers - Retrieves the total number of followers for the authenticated user.
* @property {Function} totalFollowings - Retrieves the total number of users that the authenticated user is following.
* @property {Function} whoNotFollowingBack - Retrieves users that the authenticated user is not following back.
* @property {Function} whoFollowingBack - Retrieves users that the authenticated user is following back.
* @property {Function} isFollowingBack - Checks if a user is following the authenticated user back.
* @property {Function} unfollowNotFollowingBack - Unfollows a user who is not following back.
* @property {Function} unfollowAllNotFollowingBack - Unfollows all users who are not following back.
*/
/**
* Function to Create an instance of the IfFollow Type.
*
* @function
* @param {string} yourUsername - Your GitHub username.
* @param {string} yourToken - Your GitHub personal access token.
* @returns {IfFollow} An object containing functions to interact with followers and followings.
*/
const ifFollow = require("./follow-back");
/**
* Exports the ifFollow function
* @module
* @default
* @function ifFollow
* @returns {IfFollow} An object containing functions to interact with followers and followings.
*/
module.exports = ifFollow;