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

penneo-js-sdk

v0.1.13

Published

Penneo Javascript SDK

Downloads

118

Readme

Penneo Javascript SDK

Installing dependencies

This application's dependencies are managed by npm, before proceding with the cli commands below, make sure you have node.js and npm installed.

####Install project dependencies npm handles the installation of the dependencies within the project. Check the list of dependencies in package.json in the project root, Install the dependencies with the following command.

$ npm install

How to use

The recommended way to include this sdk into your project is by using npm. Install it into your project as a dependency with

$ npm install penneo-js-sdk --save

Then either use the commands on the node execution context (server) or use a bundler tool like Browserify or Webpack to include the modules in the browser context.

Import into your project

To include this project you need to require the module by using CommonJS syntax and then calling the available functions in the SDK.

Every function needs to run with a callback that will return the response. You can check the different types of responses in the documentation

var penneo = require('./path/to/sdk');

penneo.authenticate(function(response){
	console.log('authenticated');
});

If you want to use the new ES6 syntax, you need a tool like Babel, that transpiles your code to ES5 and builds a distribution version. The same example outlined above, in conjunction with Browserify would result in

import penneo from 'penneo-js-sdk' // import directly from node_module

penneo.authenticate(function(response){
	console.log('authenticated');
});

Build from source

$ npm run compile

To build a Browser bundled distribution (with Browserify), run

$ gulp browserify

Live transpilation

To keep the bin directory up to date with the latest source code in the SDK. (useful for development and debugging), run

$ gulp live-transpile