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

limestone

v0.2.0

Published

Sphinx search server connector for Node.js

Downloads

198

Readme

Limestone is a Sphinx search server connector for Node.js

Usage:

var limestone = require("./limestone").SphinxClient(),

limestone.connect(9312, // port. 9312 is standard Sphinx port. also 'host:port' allowed
	      function(err) { // callback
		  if (err) {
		      console.log('Connection error: ' + err.message);
			  process.exit();
		  }
		  console.log('Connected, sending queries');
		  
		  limestone.query('test', function(err, answer) { // Simple query
			console.log('Simple query returned ' + answer.match_count + 'results');
		  });
		  
		  limestone.query( // Query with options
		      {'query':'test', maxmatches:1}, 
		      function(err, answer) {
			  limestone.disconnect();
			  console.log("Extended search for 'test' yielded " + 
				   answer.match_count + " results: " + 
				   JSON.stringify(answer));
		      });
	      });

To Use Build_Excerpts:

limestone.connect(9312,  // port
	function(err) { //callback
		if (err) {
		console.log('Connection error: ' + err);
		}
		console.log('Connected Build Excerpts');
		limestone.build_excerpts(
			[
				'this is my teste text to be highlighted', 
				'this is another test text to be highlighted'
			], // docs
			'questions_1',
			'test text',
			{},
			function(err, answer) {
				limestone.disconnect();
				console.log(JSON.stringify(answer));
			}
		);
	}
);

Bonus: persistent connection: You can ask sphinx to open a persistent connection. You can then make several request through the same connection

limestone.connect(9312, // port
	true, // persistent (optional)
	function(err) { // callback
		if (err){
			console.log('Connection error: ' + err);
		}
		console.log('Connected Search'); 
		console.log('sending query');  
		limestone.query({
			'query' : 'test', // query object with sphinx options
			'maxmatches' : 1,
			'indexes':'questions_1,products_3'},
			function(err, answer){ 			// callback
				console.log('Extended search yielded ' + 
					answer.match_count + " results\n" +
					JSON.stringify(answer));
			
				limestone.build_excerpts([
						'this is my test text to be highlighted', 
						'this is another test text to be highlighted'
					], // docs
					'questions_1', // index
					'test text', // words
					{},
					function(err, answer){
						limestone.disconnect();
						console.log(JSON.stringify(answer));
					}
				);
				  
			}
		);
	}
);

Limestone is queueing now: You can safely call limestone.query or limestone.build_excerpts methods outside the scope of the callback functions, provided the connection is made persistent. Limestone will enqueue the sphinx commands and run them sequentially.

This works:

limestone.connect(9312, // port. 9312 is standard Sphinx port
	      function(err) { // callback
	          ...
		  limestone.query(
		      {'query':'test', maxmatches:1}, 
		      function(err, answer) {
		          ....
		      });
	      });

limestone.query({'second query':'test'}, function(err, answer){..}); // won't crash with previous