pleerock / microframework-elasticsearch

ElasticSearch module for Microframework

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

This repository is deprecated. Microframework architecure has changed. Please consider writing your own module for a newer versions of microframework.

ElasticSearch module for Microframework

Adds integration between elastic search and microframework.

Usage

  1. Install module:

    npm install --save microframework-elasticsearch

  2. Simply register module in the microframework when you are bootstrapping it.

        import {MicroFrameworkBootstrapper} from "microframework/MicroFrameworkBootstrapper";
        import {ElasticSearchModule} from "microframework-elasticsearch/ElasticSearchModule";
        
        new MicroFrameworkBootstrapper({ baseDirectory: __dirname })
            .registerModules([
                new ElasticSearchModule()
            ])
            .bootstrap()
            .then(result => console.log('Module is running.'))
            .catch(error => console.error('Error: ', error));
  3. ES6 features are used, so you may want to install es6-shim too:

    npm install es6-shim --save

    you may need to require("es6-shim"); in your app.

  4. Now you can use elastic search module in your microframework.

Todos

  • cover with tests
  • more configuration
  • add more docs

About

ElasticSearch module for Microframework


Languages

Language:TypeScript 98.7%Language:JavaScript 1.3%