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

node-itglue

v1.0.2

Published

Node.js wrapper for the ITGlue API

Downloads

16

Readme

node-itglue

Simple authentication bindings for ITGlue.

Authentication

This library offers three methods of authentication: api key, bearer and user.

API Key


const ITGlue = require('node-itglue');

const itg = new ITGlue({
  // API Key auth
  // your api key
  apikey: 'abcdef12345',
 
  // optional
  // set true if you're connecting to the European datacenter with API Key auth
  eu: false, 
  // timeout in ms
  timeout: 10000, 
  
  // set the authentication mode
  // one of ['apikey', 'user', 'bearer', 'user-bearer']
  mode: 'apikey',
  // required when mode is set to 'user'
  // https://<your company>.itglue.com
  subdomain: 'yourcompany',
  // required when mode is set to 'user'
  user: { 
    email: '[email protected]', 
    password: 'userpassword'
  },
  // JWT, required when mode is set to 'bearer' or 'user-bearer'
  token: '12345abcdef' 
})


itg.get({path, params})
  .then(result => {
    // result
  })
  .catch(error => {
    // error
  });
  
itg.post({path, params, body}).then()

itg.delete({path, params}).then()

itg.patch({path, params, body}).then()

Bearer Authentication

const itg = new ITGlue({
  mode: 'bearer',
  token,
})

User Authentication

The library will request and cache a new bearer token in memory for the duration of the running process.

const itg = new ITGlue({
  mode: 'user',
  subdomain,
  user: {
    email, 
    password,
  }
})

Search

Using user-bearer authentication, a search endpoint is provided.

const itg = new ITGlue({
  mode: 'user-bearer',
  subdomain,
  token
});

itg.search({
  query,       // wildcard match
  related,     // return related items
  limit,       // page size
  kind,        // comma separated list of types, e.g. passwords,organizations
  sort,        // property to sort
  filter_organization_id   // filter results to an organization
})