validate-github-user

A simple npm package that checks if a given GitHub username exists by querying the GitHub API. This package returns a boolean value (true if the user exists, false if not) and is suitable for use in Node.js CLI apps or as part of any web project.

Features

• Lightweight: Minimal dependencies and easy-to-read code.
• Async API: Uses async/await for clear asynchronous operations.
• Error Handling: Provides meaningful error messages for invalid inputs or unexpected API responses.

Installation

Install the package via npm:

////usage

npm install @npm_i_swati/validate-github-user

const validateGitHubUser = require('@npm_i_swati/validate-github-user');

async function checkUser() {
  try {
    const username = 'octocat'; // GitHub's sample user
    const exists = await validateGitHubUser(username);
    console.log(`Does "${username}" exist?`, exists); // Expected output: true
  } catch (error) {
    console.error('Error:', error.message);
  }
}

checkUser();


API
validateGitHubUser(username)
Parameters:

username (string): The GitHub username to check.
Returns:
A promise that resolves to:

true if the GitHub user exists (HTTP status 200)
false if the user is not found (HTTP status 404)
Errors:
Throws an error if:

The username is not a valid non-empty string.
The GitHub API returns an unexpected response (e.g., due to rate limiting or network issues).