lucene-escape-query
DefinitelyTyped icon, indicating that this package has TypeScript declarations provided by the separate @types/lucene-escape-query package

1.0.1 • Public • Published

lucene-escape-query NPM version Build Status Dependency Status

Escape a string for a lucene query. Effectively removes all special characters.

Table of Contents generated with DocToc

Install

npm i -S lucene-escape-query

Usage

var luceneEscapeQuery = require('lucene-escape-query')
 
luceneEscapeQuery.escape('+Rainbow') // \+Rainbow

Methods

escape (<String> string)

Returns the string passed to it, with special characters escaped.

Tests

Tests are in tape and code coverage is run though covert.

  • npm test will run both server and browser tests
  • npm run test-browser and npm run test-server run their respective tests
  • npm run tdd will run the server tests on every file change.

Developing

To publish, run npm run release -- [{patch,minor,major}]

NOTE: you might need to sudo ln -s /usr/local/bin/node /usr/bin/node to ensure node is in your path for the git hooks to work

Requirements

  • npm > 2.0.0 So that passing args to a npm script will work. npm i -g npm
  • git > 1.8.3 So that git push --follow-tags will work. brew install git

License

Artistic 2.0 © Joey Baker

Package Sidebar

Install

npm i lucene-escape-query

Weekly Downloads

664

Version

1.0.1

License

Artistic-2.0

Last publish

Collaborators

  • joeybaker