npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

neverbounce

v4.4.1

Published

An API wrapper for the NeverBounce API

Downloads

15,383

Readme

Looking for the V3 API wrapper? Click here.

This is the official NeverBounce API NodeJS wrapper. It provides helpful methods to quickly implement our API in your NodeJS applications.

This package is not suitable for use in the browser! Only use it in server side applications!

Installation

To install use the following command

$ npm install neverbounce --save

Basic Usage

The API username and secret key used to authenticate V3 API requests will not work to authenticate V4 API requests. If you are attempting to authenticate your request with the 8 character username or 12-16 character secret key the request will return an auth_failure error. The API key used for the V4 API will look like the following: secret_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx. To create new V4 API credentials please go here.

const NeverBounce = require('neverbounce');

// Initialize NeverBounce client
const client = new NeverBounce({apiKey: 'secret_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'});

// Verify an email
client.single.check('[email protected]').then(
    result => {
        console.log('Result: ' + result.getResult()); // prints: "valid"
        // See VerificationObject for additional helper methods for working with
        // verification results from the the single method
    },
    err => {
        // Errors are returned by the Promise in the form of rejection. To 
        // gracefully handle errors you can use a switch or if statements to 
        // catch specific error types.
        switch(err.type) {
            case NeverBounce.errors.AuthError:
                // The API credentials used are bad, have you reset them recently?
                break;
            case NeverBounce.errors.BadReferrerError:
                // The script is being used from an unauthorized source, you may need to
                // adjust your app's settings to allow it to be used from here
                break;
            case NeverBounce.errors.ThrottleError:
                // Too many requests in a short amount of time, try again shortly or adjust
                // your rate limit settings for this application in the dashboard
                break;
            case NeverBounce.errors.GeneralError:
                // A non recoverable API error occurred check the message for details
                break;
            default:
                // Other non specific errors
                break;
        }
    }
);

For more information you can check out the /examples directory contained within the repository or visit our official documentation here.

Constants

The library exposes several constants that make working with jobs, verification results and errors easier. They can be accessed from the root NeverBounce object via the result, job, and errors properties.

Running Examples

There a several examples contained within the /examples directory included in this repo. To run these examples; first create a .env.js file in the project root containing the following text (substituting in your own API key):

module.exports = {
  apiKey: 'secret_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
};

Once that file has been created you can run the examples with the following command, replacing the script name with the specific example you intend to run.

node ./examples/account-info.js