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

promote-js

v0.0.28

Published

Promote JavaScript SDK

Downloads

121

Readme

Promote JavaScript SDK

Promote helps you discover, recruit, engage, track, and manage top-performing affiliates, referrals, resellers, and more with a single partner management platform.

The JavaScript SDK allows you to automatically capture leads attributes, customer attributes and actions on your site or application.

It can be used both in Node.js or in the browser.


Getting Started

Create a Promote account and get your API key


Installation

Client(Browser)

Include the script into your head element

<script src="https://unpkg.com/promote-js/dist/promote.js"></script>

Node

npm install promote-js


Tracking Events with the SDK

After installing the sdk as stated above, tracking events can be performed very easily.

To track sign up on the browser PromoteJS.trackSignUp("customername","customerEmail");

or on Node as follows:

import PromoteJS from "promote-js";

PromoteJS.trackSignUp("customername","customerEmail");

Get the currently active Promoter Reference:

let activePromoterId = PromoteJS.getActivePromoterReference(); //Returns undefined or data

Set the retrieved activePromoterId as client_reference_id when initiating your stripe checkout in the backend

If you are using stripe.redirectToCheckout();

Pass the promoter reference as an optional argument to the redirecToCheckOut function like this

stripe.redirectToCheckout(
  ...
                          
  successUrl: 'https://example.com/success',
  cancelUrl: 'https://example.com/cancel',
  clientReferenceId: PromteJS.getActivePromoterReference(); //Returns undefined or data
);

If you are taking care of the checkout from the backend, use client_reference_id.