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: about 1 year 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 (almost 13 years ago)
• Default Branch: master
• Last Pushed: 2025-04-04T11:27:22.000Z (about 1 year ago)
• Last Synced: 2025-04-18T18:26:36.177Z (about 1 year ago)
• Topics: nlp, offline-first, search
• Language: JavaScript
• Homepage:
• Size: 20.3 MB
• Stars: 1,409
• Watchers: 34
• Forks: 151
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-static-website-services - search-index - A persistent, network resilient, full text search library for the browser and Node.js (Search / Surveys)
• awesome-github-projects - search-index - A persistent, network resilient, full text search library for the browser and Node.js ⭐1,423 `JavaScript` (📦 Legacy & Inactive Projects)

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)