Skip to content
Mongoose plugin to automatically index newly created documents for Algolia
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src
tests
.editorconfig
.eslintrc
.gitignore
.hound.yml
.travis.yml
CONTRIBUTING.md
DOCUMENTATION.md
LICENSE
README.md
appveyor.yml
index.js
package.json

README.md

Build Status Coverage Status Build status Dependency Status Inline docs

mongoose-algolia-index

Join the chat at https://gitter.im/riyadhalnur/mongoose-algolia-index

Mongoose plugin to automatically index newly created documents for Algolia.

NOTE: This project is in BETA. It is not properly ready for production use yet. The API is subject to change as we get closer to releasing the stable version (1.0.0).

Installation

npm install mongoose-algolia-index --save

Usage

const mongoose = require('mongoose');
const algoliaPlugin = require('mongoose-algolia-index');

let TestSchema = new mongoose.Schema({
  name: String
});

TestSchema.plugin(algoliaPlugin, {
  index: true,
  schemaName: 'Test',
  applicationId: '<your-application-id>',
  apiKey: '<your-api-key>'
});

mongoose.model('Test', TestSchema);

Documentation

Read the documentation in DOCUMENTATION.

Contributing

Read the CONTRIBUTING guide for information.

License

Licensed under MIT. See LICENSE for more information.

Issues

Report a bug in issues.

Made with love in Dhaka, Bangladesh by Riyadh Al Nur

You can’t perform that action at this time.