Skip to content
master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
src
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

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

About

Mongoose plugin to automatically index newly created documents for Algolia

Topics

Resources

License

Packages

No packages published