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-incandescent-client

v1.0.0

Published

A node.js client for the Incandescent reverse image search API

Downloads

5

Readme

node-incandescent-client

A client for the Incadescent (http://incandescent.xyz/) reverse image search API

Installation

npm install node-incandescent-client

Usage

Please see example.js for a complete flow example.

var incan_client = require("node-incandescent-client").client;

var client = new incan_client(YOUR_UID, YOUR_API_KEY);

client.addImageUrl('http://incandescent.xyz/wp-content/themes/twentyfifteen/logo.png');

client.assemble();

client.sendRequest(function(projectId) { 
	console.log(projectId);

	client.getResults(projectId, function(data) {
		console.log(data);
	})
});

new client(uid, apiKey)

Creates a new client for the Incandescent API, using the passed UID and API key to sign requests.

client.addImageUrl(imageUrl)

Adds an image URL to the current request for lookup. Note that you can add several image URLs for lookup in the same request

client.assemble(secondsToExpiration)

Assembles the request for lookup. Note that this is called after (one or more) calls to client.addImageUrl, and client.assemble generates the required authentication front-matter for the request. secondsToExpiration is an optional Number parameter between 0 and 1200 which specifies the maximum time between the client.assemble call and the client.sendRequest call.

client.sendRequest(onProjectCreation)

Sends the client.assemble'd request to the Incandescent API. Consumes a callback, onProjectCreation, which will be called with the projectId returned by Incandsecent for the search request.

client.getResults(projectId, onResults)

Using the passed projectId (presumably generated using a call to client.sendRequest), query the Incandescent result server every few seconds until the search is complete, passing the raw response data (according to the format specified by http://incandescent.xyz/docs/) to the onResults callback.