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 🙏

© 2025 – Pkg Stats / Ryan Hefner

@crush-pics/crush-pics

v0.2.2

Published

Crush.pics NodeJS Module

Downloads

14

Readme

Crush.pics Node Client Library

This is the node.js Library for integrating with Crush.pics API. Sign up for a Crush.pics account here.

Installation

Install the latest version of the library with the following command:

$ npm i @crush-pics/crush-pics

Then require the library:

var CrushPics = require('@crush-pics/crush-pics');

Documentation

The full documentation can be found here

Get started

In order to perform API calls you need to configure your client - provide your private API token:

var CrushPics = require('@crush-pics/crush-pics');

CrushPics.configure({
  api_token: '<your API key>'
});

Dashboard

Get information about your account and quota consumption report

var type = 'week'; # also supports 'month' & 'six_months'

CrushPics.dashboard.get({ report_type: type }).then(function(response) {
  console.log(response);
});

Consumption report comes in ApexCharts.js compatible format.

Example:

var renderChart = function(data) {
  // ApexCharts.js initialization options
  var options = {
    chart: {
      height: 350,
      width: '100%',
      type: 'bar',
      stacked: true,
    }
  }
  var report = data.stats.consumption;
  var values = $.map(report.series, function(p, k) {
    return p
  });
  
  options.series = $.map(report.series, function(v, k) {
    return {
      name: window.i18n.origins[k], // customize labels
      data: v
    }
  });
  
  options.xaxis.categories = report.columns;

  var chart = new ApexCharts(
    document.querySelector("#consumption-chart"),
    options
  );

  chart.render();
}

CrushPics.dashboard.get({ report_type: 'week' }).then(function(response) {
  renderChart(result.data);
});

Async compression

You can send you an image to compression by uploading actual blob or just providing a link to the file

CrushPics.original_images
  .create({
    image_url: 'https://example.com/image.jpeg',
    compression_type: 'balanced',
  })
  .then(function(response) {
    console.log(response);
  });
var file = input.files[0]

CrushPics.original_images
  .create({
    file: file,
    compression_type: 'balanced',
  })
  .then(function(response) {
    console.log(response);
  });

Sync compression

You can send you an image to compression by uploading actual blob or just providing a link to the file

CrushPics.original_images
  .compress({
    image_url: 'https://example.com/image.jpeg',
    compression_type: 'balanced',
  })
  .then(function(response) {
    console.log(response);
  });
var file = input.files[0]

CrushPics.original_images
  .compress({
    file: file,
    compression_type: 'balanced',
  })
  .then(function(response) {
    console.log(response);
  });

List uploaded images

CrushPics.original_images
  .list()
  .then(function(response) {
    console.log(response);
  });

Get details of uploaded image

CrushPics.original_images
  .get(11)
  .then(function(response) {
    console.log(response);
  });

Get account details

CrushPics.account
  .get()
  .then(function(response) {
    console.log(response);
  });

Update account details

You can change your account details including default compression settings

CrushPics.original_images
  .update({
    compression_level_jpg: 70,
    compression_level_png: 70,
    compression_level_gif: 70,
    compression_type: 'balanced'
  })
  .then(function(response) {
    console.log(response);
  });

List Callback URLs

CrushPics.callback_urls
  .list()
  .then(function(response) {
    console.log(response);
  });

Create Callback URL

You can change your account details including default compression settings

CrushPics.callback_urls
  .create({
    url: 'https://example.com/webhook'
  })
  .then(function(response) {
    console.log(response);
  });

Delete Callback URL

You can change your account details including default compression settings

CrushPics.callback_urls
  .delete(12)
  .then(function(response) {
    console.log(response);
  });