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

paper-handler

v1.0.2

Published

Official nodeJS module to request paperhandler API. Provides necessary functionalities to ask for permissions, get, put and delete user files.

Downloads

9

Readme

paper-handler-module

Official paper-handler API for nodeJS

Installation :

The package is available on npm :

npm i -S paper-handler

How to use paper-handler API ?

Get permissions :

/* example of options to ask for permissions */
const options = {
    type : "EDIT", /* Or "READ"*/
    topics : ["school"], /* topics for which you want the permission */
    users : ["[email protected]","[email protected]"] /* users for which you want to have the permission */
}


/* ask for permission */
ph.askForPermission("YOUR_DEVELOPER_KEY", options)
    .then((response)=>{
        /* handle the success result */
        console.log(response);
    })
    .catch((error)=>{
        /* handle the error */
        console.log(error);
    });

Get a file :

/* example of options necessary to request for a file or tu put one */
const fileOptions = {
    topic : "electricity",
    year : "2017",
    month : "March",
    target : "[email protected]"
};


/**
 * Example to get a file from paper-handler server.
 * (Transaction authorized only if you have the correct permissions)
 */

ph.getFile("YOUR_DEVELOPER_KEY",fileOptions)
    .then((readStream)=>{
        /* transaction has been authorized*/

        var writeStream = fs.createWriteStream('example.pdf');
        /* pipe your writeStream to response readStream to get the file*/
        readStream.pipe(writeStream);

    })
    .catch((error)=>{
        /* handle error*/
        console.log(error.message);
    });

Put a file :

/* example of options necessary to request for a file or tu put one */
const fileOptions = {
    topic : "electricity",
    year : "2017",
    month : "March",
    target : "[email protected]"
};

/**
 * Example to put a file on the server for a user
 * (Works only if you have necessary permissions)
 */

var readStream = fs.createReadStream('myPdf.pdf');
ph.putFile("YOUR_DEVELOPER_KEY",fileOptions,readStream,'test.pdf')
    .then((response)=>{
        /* the file has been put successfully */
        console.log(response);
    })
    .catch((error)=>{
        /* Something wrong happened*/
        console.log(error);
    });

If you have any question, do not hesitate to ask via contact form Paperhandler.