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

elastic-email-promise

v1.0.1

Published

LITE & EASY Elastic Email API Wrapper with ES 2015 Promises.

Downloads

30

Readme

This LITE Wrapper, allows you to quickly and easily use the Elastic Email API v2 via Node.js and with ES 2015 Promises.

Latest Stable Version License NPM Downloads

Quick Examples:

Install:

npm i elastic-email-promise

Set up your client:

const ee = require( 'elastic-email-promise' );
const eeClient = ee.Client( { apikey: 'Your Apikey' } );

request method with only api key required:

eeClient.request( '/account/load' )
    .then( function( data ) { console.log( data ) } )
    .catch( function( error ) { console.log( error ) } );

request method with more parameters:

eeClient.request( '/contact/findcontact', { email: '[email protected]' } )
    .then( function( data ) { console.log( data ) } )
    .catch( function( error ) { console.log( error.message ) } )

request method with file upload:

const fs = require('fs');

eeClient.request( '/contact/upload', {
    contactFile: fs.createReadStream('CSV_Sample1.csv')
    })
	.then( function( data ) { console.log( data ) } )
	.catch( function( error ) { console.log( error.message ) } )

Request method:

 eepromise.request( 'path', { params } );

path : string; path for method (f.e. "/channel/list") params: object; parameters for method return => Promise Object with respond

More information about EE Api methods you can find in EE API Documentation

How does elastic-email-promise pass Elastic Email response?

Elastic Email API (version 2) response dosen't have correct HTTP status code. All responses are JSON string:

//On success
{success: true, data: /* response data it could be array or object */}
//On false
{success: false, error: 'error message as string'}
  1. Elastic Email Promise will try parse response to JSON.
  • If something goes wrong, the exception be thrown to Promise reject
  1. Then JSON success parameter will be check.
  • If true: resolve( data );
  • If false: reject( new Error( error ) );