base-search
Advanced tools
Base plugin that adds methods for creating, updating and using search indices.
Base plugin that adds methods for creating, updating and using search indices.
Install with npm:
$ npm install --save base-search
var search = require('base-search');
Plugin for base applications like generate, assemble, verb, and update to add an instance of sarge as app.search that has methods for creating search indices using indexers.
Params
config {Object}: Configuration object used to specify default indexer to use.returns {Function}: Plugin function passed to app.use methods.Example
var app = assemble();
app.use(search());
console.log(app.search);
Indexers are objects that have collect and index methods that will be executed when collect or index are called on app.search.
The indexer objects may be plain objects or instances created with those methods. See the examples to see what indexers may look like.
Simple object to be used in examples below.
var indexer = {};
The collect method on an indexer will be passed a file object and a next callback. The collect method
should create an object to pass back to next that will be added to the .files collection on the search instance.
If file is a view from assemble, we can collect information about the file that we want to index:
indexer.collect = function(file, next) {
var obj = {
key: file.key,
title: file.data.title,
category: file.data.category,
url: file.data.url,
body: file.content
};
// return the object
next(null, obj);
};
The index method on an indexer will be passed a files object containing all fo the collected files, an options object which is the same as the options passed into the search.index method, and a callback function to call when indexing is complete. The callback function is the same as the one passed into the search.index method so users may choose to return additional information if necessary.
indexer.index = function(files, options, cb) {
for (var key in files) {
if (files.hasOwnProperty(key)) {
console.log(key);
console.log(files[key]);
console.log();
}
}
cb();
};
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Please read the contributing guide for advice on opening issues, pull requests, and coding standards.
(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)
To generate the readme, run the following command:
$ npm install -g verbose/verb#dev verb-generate-readme && verb
Install dev dependencies:
$ npm install && npm test
Brian Woodward
Copyright © 2017, Brian Woodward. MIT
This file was generated by verb-generate-readme, v0.4.2, on February 01, 2017.
FAQs
Base plugin that adds methods for creating, updating and using search indices.
We found that base-search demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Campaign-level threat intelligence in Socket now shows when active supply chain attacks affect your repositories and packages.
Research
Malicious PyPI package sympy-dev targets SymPy users, a Python symbolic math library with 85 million monthly downloads.
Security News
Node.js 25.4.0 makes require(esm) stable, formalizing CommonJS and ESM compatibility across supported Node versions.