https://github.com/fergiemcdowall/search-index

A persistent, network resilient, full text search library for the browser and Node.js
https://github.com/fergiemcdowall/search-index

nlp offline-first search

Last synced: 12 days ago
JSON representation

A persistent, network resilient, full text search library for the browser and Node.js

• Host: GitHub
• URL: https://github.com/fergiemcdowall/search-index
• Owner: fergiemcdowall
• License: mit
• Created: 2013-07-04T07:56:35.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2024-10-19T20:20:53.000Z (21 days ago)
• Last Synced: 2024-10-22T03:57:03.668Z (19 days ago)
• Topics: nlp, offline-first, search
• Language: JavaScript
• Homepage:
• Size: 14.4 MB
• Stars: 1,385
• Watchers: 35
• Forks: 149
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# search-index

### A network resilient, persistent full-text search library for the browser and Node.js

[![npm](https://img.shields.io/npm/v/search-index.svg?style=flat-square)](https://www.npmjs.com/package/search-index)

[![npm](https://img.shields.io/npm/dm/search-index.svg?style=flat-square)](https://npm-stat.com/charts.html?package=search-index)

[![license](https://img.shields.io/github/license/mashape/apistatus.svg?style=flat-square)](LICENCE)

[![Build Status](https://travis-ci.org/fergiemcdowall/search-index.svg?branch=master)](https://travis-ci.org/fergiemcdowall/search-index)

[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg?style=flat-square)](https://standardjs.com)

## Quick start

```javascript

import { SearchIndex } from 'search-index' 

// initialize an index

const { PUT, QUERY } = new SearchIndex(options)

// add documents to the index

await PUT(documents)

// read documents from the index

const results = await QUERY(query)

```

## Documentation

* [Browser

  demo](https://codesandbox.io/p/github/fergiemcdowall/search-index-demo/)

  ([source code](https://github.com/fergiemcdowall/search-index-demo))

* [API](docs/API.md)

* [FAQ](docs/FAQ.md)