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

@quivers/node

v0.0.3

Published

This is the official node.js package for connecting to the Quivers Public API.

Downloads

1

Readme

Quivers JavaScript SDK (node.js)

This is the Official Quivers JavaScript SDK. It allows for an easy way to interface with the Quivers Public API. This is an NPM package intended to run via node.js. For a browser distribution, please see @quivers/browser.

This package can be installed to your npm project using npm install @quivers/node.

How to Use

The Quivers SDK exposes a class Quivers, which can be instantiated with options to specify the target environment (prod by default), an apikey for authentication, and if websockets should be preferred for API requests.

const Quivers = require('@quivers/node');

var quivers = new Quivers({
	environment: "dev" || "test" || "demo" || "prod", //(default:prod)
	apikey: "apikey", //(default: null)
	websocket: true || false //(default: true)
});

This library supports async/await and promises (callbacks are not supported).

var quivers = new Quivers;

//within an `async` function: -
let countries = await quivers.get('countries');

//using a promise
quivers.get(`countries`)
.then((countries) => {
	//countries
})
.catch((err) => {
	//oops, something went wrong.
})

Methods

Quivers.get(route, data, callback = null)

This will perform a GET request against a given endpoint (e.g. users/current). the data will be appeneded as query parameters to the route (e.g. business/search & {pagesize:1} will transform the route to businesses/search?pagesize=1).

Quivers.post(route, data = null, callback = null)

This will perform a POST request against a given endpoint (e.g. users/register). the data will JSON stringified and passed to the body (query parameters should be passed as part of the route when using post()).

Quivers.delete(route, callback = null)

This will perform a DELETE request against a given endpoint (e.g. auth/logout).

Developing this Project

All code for the Quivers library is available within ./quivers.js. When working with this project, follow the standard Quivers development & deployment workflows.

Deployment

When a commit is pushed to the master branch of this repository, Bitbucket Pipelines attempt to deploy this project by publshing it to NPM. A version will only be successfully published if the package version has changed. Package version uses Semantic Versioning

Author