mongoose-searchable

    1.0.0 • Public • Published

    mongoose-searchable

    Build Status

    keywords based searching for mongoose models, utilizing mongodb text search

    Installation

    $ npm install --save mongoose-searchable

    Usage

    var mongoose = require('mongoose');
    var Schema = mongoose.Schema;
    var searchable = require('mongoose-searchable');
     
    //define schema
    var BookSchema = new Schema({
        title: {
            type: String,
            required: true
        },
        authors: [String],
        categories: [{
            type: String
        }]
    });
     
    //make all string field searchable
    BookSchema.plugin(searchable);
     
    //compile model
    var Book = mongoose.model('Book', BookSchema);
     
    //search comic books
    Book.search('comic', function(error, books){
        ...
    });
     
    //search and exclude books contain comic keyword
    Book.search('love -comic', function(error, books){
        ...
    });
     
    //search books authored by any of following authors
    Book.search(['Amaya Blick', 'Otho Prosacco III'], function(error, books){
        ...
    });
     

    Plugin Options

    • keywordField specifies which schema field to be used to store keywords. default to keywords.
    • extract optional function that used to extract language specific keywords from fields. If not provided glossary will be used
    • fields specifies which fields fields to be used for computing keywords. default to all fields with string schema type
    • blacklist specifies a collections of words to remove from keywords. default to []
    • language change the search language. Default to english. If you specify a language value of "none", then the text search uses simple tokenization with no list of stop words and no stemming.

    Example:

    BookSchema.plugin(searchable,{
        keywordField:'keywords',
        language:'english',
        fields:['title','authors'],
        blacklist:['comic','batman'],
        extract: function(content, done){
            done(null, content.split(' '));
        }
    });

    API

    search(terms, callback(error, found))

    A static method used to search documents

    • terms an array of string or space separated string containing terms used to search documents
    • callback(error, found) an optional callback provide to run a query.

    Example:

    Book.search(terms, function(error, foundBooks) {
        ...
    });
     

    keywordize([keywords], callback(error, instance))

    An instance method used to compute instance keywords from keyword fields and union it with the optional provided additional keywords

    Example:

    var book = new Book();
    expect(book.keywords).to.have.length(0);
     
    var keywords = faker.lorem.words();
     
    book.keywordize(function(error, _book) {
        
        expect(_book.keywords).to.have.length.above(0);
        expect(_book.keywords).to.contain(keywords[0]);
     
        done(error, _book);
    });
     

    unkeywordize(keywords)

    An instance method used to remove provided keywords from an instance.

    Example:

    var book = new Book();
    expect(book.keywords).to.have.length(0);
     
    var keywords = faker.lorem.words();
    book.keywordize(keywords);
     
    book.unkeywordize(keywords[0]);
     
    expect(book.keywords).to.have.length.above(0);
    expect(book.keywords).to.not.contain(keywords[0]);
     

    Testing

    • Clone this repository

    • Install grunt-cli global

    $ npm install -g grunt-cli
    • Install all development dependencies
    $ npm install
    • Then run test
    $ npm test

    Contribute

    Fork this repo and push in your ideas. Do not forget to add a bit of test(s) of what value you adding.

    References

    Licence

    Copyright (c) 2015 lykmapipo & Contributors

    Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

    The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

    THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

    Install

    npm i mongoose-searchable

    DownloadsWeekly Downloads

    38

    Version

    1.0.0

    License

    MIT

    Last publish

    Collaborators

    • lykmapipo