### Install isvalid-email Source: https://github.com/dendibaev-dev/isvalid-email/blob/main/README.md Install the package using npm. ```sh npm i @dendibaev/isvalid-email ``` -------------------------------- ### Import isvalid-email (ES Modules) Source: https://github.com/dendibaev-dev/isvalid-email/blob/main/README.md Import the library using ES module syntax. ```javascript import isValidEmail from "@dendibaev/isvalid-email"; ``` -------------------------------- ### Import isvalid-email (CommonJS) Source: https://github.com/dendibaev-dev/isvalid-email/blob/main/README.md Import the library using require for CommonJS environments. ```javascript const isValidEmail = require("@dendibaev/isvalid-email"); ``` -------------------------------- ### isValidEmail Function Source: https://github.com/dendibaev-dev/isvalid-email/blob/main/README.md The core function of the library to validate an email address. ```APIDOC ## isValidEmail(string) ### Description Returns a Boolean indicating whether `string` is a valid email. ### Method Function Call ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example ```javascript const isValidEmail = require("@dendibaev/isvalid-email"); const email = "test@example.com"; const invalidEmail = "invalid-email"; console.log(isValidEmail(email)); // Output: true console.log(isValidEmail(invalidEmail)); // Output: false ``` ### Response #### Success Response (Boolean) - **true**: if the email string is valid. - **false**: if the email string is invalid. #### Response Example ```json { "example": "true" } ``` ```json { "example": "false" } ``` ``` -------------------------------- ### Validate Email Address Source: https://github.com/dendibaev-dev/isvalid-email/blob/main/README.md Use the isValidEmail function to check if a string is a valid email address. It returns a boolean. ```javascript const isValidEmail = require("@dendibaev/isvalid-email"); // Example usage: const email = "test@example.com"; const valid = isValidEmail(email); console.log(`${email} is valid: ${valid}`); ``` -------------------------------- ### Email Validation API Source: https://context7.com/dendibaev-dev/isvalid-email/llms.txt The `isValidEmail` function validates if a given value is a properly formatted email address. It accepts any input type but returns true only for strings that match the email pattern. Non-string inputs automatically return false. ```APIDOC ## isValidEmail(value) ### Description Validates whether the provided value is a properly formatted email address. The function accepts any input type but only returns true for strings that match the email pattern. It checks for valid local parts (before @), proper domain format, and correct TLD structure. Non-string inputs (numbers, booleans, functions, undefined) automatically return false. ### Method Function Call ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example ```javascript const isValidEmail = require("@dendibaev/isvalid-email"); // Valid email addresses console.log(isValidEmail("test@gmail.com")); // true console.log(isValidEmail("test_name@gmail.com")); // true console.log(isValidEmail("test.dev@gmail.com")); // true console.log(isValidEmail("user@subdomain.example.com")); // true // Invalid email addresses - improper dot placement console.log(isValidEmail("test...@gmail.com")); // false console.log(isValidEmail("test@gmail.")); // false console.log(isValidEmail("test@.com")); // false console.log(isValidEmail("test.@gmail.com")); // false // Invalid inputs - non-string types console.log(isValidEmail()); // false (undefined) console.log(isValidEmail(123)); // false (number) console.log(isValidEmail(NaN)); // false (NaN) console.log(isValidEmail(true)); // false (boolean) console.log(isValidEmail(false)); // false (boolean) console.log(isValidEmail(() => "test")); // false (function) // Practical usage in form validation function validateUserInput(email) { if (!isValidEmail(email)) { return { valid: false, error: "Please enter a valid email address" }; } return { valid: true, email: email.toLowerCase() }; } console.log(validateUserInput("user@example.com")); // { valid: true, email: "user@example.com" } console.log(validateUserInput("invalid-email")); // { valid: false, error: "Please enter a valid email address" } ``` ### Response #### Success Response (true/false) - **boolean** - Returns `true` if the input is a valid email string, `false` otherwise. #### Response Example ```json { "example": "true" } ``` #### Error Response None explicitly defined, non-string inputs return `false`. ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.