National Preventative Mechanism

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

    2.1.1 • Public • Published

    lucene   Build Status Dependency Status Coverage Status npm version

    Parse, modify and stringify lucene queries.

    Installation | Try It | Usage | Grammar | History


    Installation

    npm install --save lucene
    -or-
    yarn add lucene
    

    Usage

    const lucene = require('lucene');
     
    const ast = lucene.parse('name:frank OR job:engineer');
    console.log(ast);
    // {
    //   left: {
    //     field: 'name',
    //     term: 'frank'
    //   },
    //   operator: 'OR',
    //   right: {
    //     field: 'job',
    //     term: 'engineer'
    //   }
    // }
     
    console.log(lucene.toString(ast));
    // name:frank OR job:engineer

    Grammar

    The parser is auto-generated from a PEG implementation in JavaScript called PEG.js.

    To test the grammar without using the generated parser, or if you want to modify it, try out PEG.js online. This is a handy way to test arbitrary queries and see what the results will be like or debug a problem with the parser for a given piece of data.

    History

    This project is based on thoward/lucene-query-parser.js and its forks (most notably xomyaq/lucene-queryparser). The project is forked to allow some broader changes to the API surface area, project structure and additional capabilities.

    Install

    npm i lucene

    DownloadsWeekly Downloads

    6,808

    Version

    2.1.1

    License

    MIT

    Unpacked Size

    86.1 kB

    Total Files

    9

    Last publish

    Collaborators

    • bripkens