ssb-fulltext

fulltext search for ssb messages

Usage no npm install needed!

<script type="module">
  import ssbFulltext from 'https://cdn.skypack.dev/ssb-fulltext';
</script>

README

ssb-fulltext

Fulltext search for SSB messages.

Uses the full text search engine levi.

Install

With scuttlebot running, install the ssb-fulltext plugin:

sbot plugins.install ssb-fulltext

Then restart scuttlebot. It will take a while for ssb-fulltext to index the database. You will see progress in the form of plusses (+) on the console.

API

search: source

Search the database for text

search {query}
search --query {query} [--values] [--no-values]

search(query)
search({ query:, values: })
  • query (string): The search query
  • values (boolean, default: true): whether the data event should contain values.

The objects in this stream will be of the form:

{ key: MsgID, value: Msg, rank: number }

License

Copyright (c) 2016 Charles Lehner

Usage of the works is permitted provided that this instrument is retained with the works, so that any entity that uses the works is notified of this instrument.

DISCLAIMER: THE WORKS ARE WITHOUT WARRANTY.