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-text-match

v1.10.1

Published

Simple query language for javascript strings

Downloads

18

Readme

#Simple string query language Node.js module

Build Status Coverage

##Overview

Query a string by creating a query object, instead of having to contruct a regex or parse anything.

Every query object has a 'type' field, one of:

['AND', 'OR', 'NOT', 'WITHIN', 'MATCH', 'EXACT']

As well as a type field, a query object will contain either 1 or 2 'arg' fields.

Some examples of query objects:

// Match a string if it contains the word 'film'
var query1 = {
	type:"MATCH",
	arg1:"film"
};

// This query matches a string if it contains both 'FILM' (only in uppercase) and 'amazing' (any case)
var query2 = {
	type:"AND",
	arg1:{
		type:"EXACT",
		arg1:"FILM"
	},
	arg2:{
		type:"MATCH",
		arg1:"amazing"
	}
}

// This query matches if the string does not contain both 'FILM' (uppercase) and 'amazing' (any case)
var query4 = {
	type:"NOT",
	arg1:query2
}


// More complex queries can then be made by nesting query objects
var query5 = {
	type:"OR",
	arg1:query1,
	arg2:query2
}

###Usage:


var query = require('node-text-match');

var exampleQuery = {
	type:"EXACT",
	arg1:"AMAZING"
};

var testString = "That film was AMAZING";

query.parseQuery(testString, exampleQuery);
--> true

AND & OR are binary operators and are of the following form:

{
	type:"AND",
	arg1:{
		//another query object
	},
	arg2:{
		//another query object
	}
};

{
	type:"OR",
	arg1:{
		//another query object
	},
	arg2:{
		//another query object
	}
};

WITHIN is also a binary operator, but requires an extra parameter:


// matches strings containing the word 'film' within 3 words of 'good'
{
	type:"WITHIN",
	arg1:"film",
	arg2:"good",
	within:3
};

EXACT, MATCH and NOT are uniary operators:

// loose match
{
	type:"MATCH",
	arg1:"amazing!!"
}

// exact match
{
	type:"EXACT",
	arg1:"AMAzing"
}

// ignore strings that return true for arg1 query
{
	type:"NOT",
	arg1:{
		type:"EXACT",
		arg1:"film"
	}
}