https://github.com/hyper63/hyper-adapter-minisearch
Minisearch adapter for Hyper Search port
https://github.com/hyper63/hyper-adapter-minisearch
Last synced: about 1 year ago
JSON representation
Minisearch adapter for Hyper Search port
- Host: GitHub
- URL: https://github.com/hyper63/hyper-adapter-minisearch
- Owner: hyper63
- License: apache-2.0
- Created: 2021-06-17T16:51:49.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2023-11-28T23:46:21.000Z (over 2 years ago)
- Last Synced: 2025-01-13T05:41:39.680Z (about 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 133 KB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
hyper-adapter-minisearch
A Search port adapter that uses minisearch in the hyper service framework
---
- [Background](#background)
- [Getting Started](#getting-started)
- [Installation](#installation)
- [Features](#features)
- [Methods](#methods)
- [Contributing](#contributing)
- [Testing](#testing)
- [License](#license)
## Background
[`Minisearch`](https://www.npmjs.com/package/minisearch) is a tiny but powerful in-memory fulltext
search engine written in JavaScript. It is respectful of resources, and it can comfortably run both
in Node and in the browser.
## Getting Started
```js
import { default as minisearch } from 'https://x.nest.land/hyper-adapter-minisearch@1.0.10/mod.js'
export default {
app,
adapter: [
{
port: 'search',
plugins: [minisearch({ dir: '/tmp' })],
},
],
}
```
## Installation
This is a Deno module available to import from
[nest.land](https://nest.land/package/hyper-adapter-minisearch)
deps.js
```js
export { default as minisearch } from 'https://x.nest.land/hyper-adapter-minisearch@1.0.14/mod.js'
```
## Features
- create an index in Minisearch
- delete an index in Minisearch
- index a document using Minisearch
- retrieving an indexed document from Minisearch index
- update an indexed document in Minisearch index
- remove an indexed document from Minisearch index
- bulk operation to index multiple docs using Minisearch
- query an Minisearch index
## Methods
This adapter fully implements the Search port and can be used as the
[hyper Search service](https://docs.hyper.io/search-api) adapter
See the full port [here](https://nest.land/package/hyper-port-search)
## Contributing
Contributions are welcome! See the hyper
[contribution guide](https://docs.hyper.io/contributing-to-hyper)
## Testing
```
./scripts/test.sh
```
To lint, check formatting, and run unit tests
## License
Apache-2.0