Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/lykmapipo/mongoose-regex-search

mongoose plugin to regex search on schema searchable fields
https://github.com/lykmapipo/mongoose-regex-search

like mongodb mongoose mongoose-plugin plugin regex search searchable

Last synced: 3 days ago
JSON representation

mongoose plugin to regex search on schema searchable fields

Host: GitHub
URL: https://github.com/lykmapipo/mongoose-regex-search
Owner: lykmapipo
License: mit
Created: 2017-02-08T16:53:32.000Z (over 7 years ago)
Default Branch: master
Last Pushed: 2023-03-01T02:23:00.000Z (over 1 year ago)
Last Synced: 2024-09-18T17:31:05.781Z (8 days ago)
Topics: like, mongodb, mongoose, mongoose-plugin, plugin, regex, search, searchable
Language: JavaScript
Homepage:
Size: 2.05 MB
Stars: 10
Watchers: 2
Forks: 1
Open Issues: 5
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md

Awesome Lists containing this project

README

        # mongoose-regex-search

[![Build Status](https://app.travis-ci.com/lykmapipo/mongoose-regex-search.svg?branch=master)](https://app.travis-ci.com/lykmapipo/mongoose-regex-search)

[![Dependencies Status](https://david-dm.org/lykmapipo/mongoose-regex-search.svg)](https://david-dm.org/lykmapipo/mongoose-regex-search)

[![Coverage Status](https://coveralls.io/repos/github/lykmapipo/mongoose-regex-search/badge.svg?branch=master)](https://coveralls.io/github/lykmapipo/mongoose-regex-search?branch=master)

[![GitHub License](https://img.shields.io/github/license/lykmapipo/mongoose-regex-search)](https://github.com/lykmapipo/mongoose-regex-search/blob/master/LICENSE)

[![Commitizen Friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)

[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/prettier/prettier)

[![Code Style](https://badgen.net/badge/code%20style/airbnb/ff5a5f?icon=airbnb)](https://github.com/airbnb/javascript)

[![npm version](https://img.shields.io/npm/v/mongoose-regex-search)](https://www.npmjs.com/package/mongoose-regex-search)

mongoose plugin to regex search on schema searchable fields. 

> It support regex search in `string schema fields`, `array of strings`, `single embeded doc string fields` and `array embeded doc string fields` with `searchable: true` option.

## Requirements

- [NodeJS v13+](https://nodejs.org)

- [Npm v6.12+](https://www.npmjs.com/)

- [MongoDB v4+](https://www.mongodb.com/)

- [Mongoose v6+](https://github.com/Automattic/mongoose)

## Install

```sh

$ npm install --save mongoose mongoose-regex-search

```

## Usage

```javascript

import mongoose from 'mongoose';

import searchable from 'mongoose-regex-search';

const UserSchema = new mongoose.Schema({

    name: { type: String, searchable: true },

    age: { type: Number }

});

UserSchema.plugin(searchable);

const User = mongoose.model('User', UserSchema);

// search and run query

User.search('john', (error, results) => { ... });

User.search('john', { $age: { $gte: 14 } }, (error, results) => { ... });

// search return query for futher chaining

let query = User.search('john');

let query = User.search('john', { $age: { $gte: 14 } });

```

## Testing

* Clone this repository

* Install all development dependencies

```sh

$ npm install

```

* Then run test

```sh

$ npm test

```

## Contribute

It will be nice, if you open an issue first so that we can know what is going on, then, fork this repo and push in your ideas. Do not forget to add a bit of test(s) of what value you adding.

## Licence

The MIT License (MIT)

Copyright (c) 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.