# ssb-meme

> Uses [flumeview-search](https://github.com/flumedb/flumeview-search) to build an index of all images names.

Latest version **1.1.0** (published 2020-06-26) · MIT license · 0 weekly downloads

## Install

```sh
npm install ssb-meme
pnpm add ssb-meme
yarn add ssb-meme
bun add ssb-meme
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2020-06-26 |
| First published | 2018-05-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 5.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 7 |
| Maintainers | mixmix |

## Links

- npm: https://www.npmjs.com/package/ssb-meme
- Repository: https://github.com/ssbc/ssb-meme
- Homepage: https://github.com/ssbc/ssb-meme#readme
- Issues: https://github.com/ssbc/ssb-meme/issues
- npm.io page: https://npm.io/package/ssb-meme

## Dependencies (3)

- [ssb-ref](https://npm.io/package/ssb-ref.md) ^2.11.1
- [flumeview-search](https://npm.io/package/flumeview-search.md) ^2.0.0
- [is-my-json-valid](https://npm.io/package/is-my-json-valid.md) ^2.17.2

## Recent versions

- 1.1.0 (latest) — 2020-06-26
- 1.0.4 — 2018-05-28
- 1.0.3 — 2018-05-28
- 1.0.2 — 2018-05-28
- 1.0.1 — 2018-05-28
- 1.0.0 — 2018-05-27

## README

# ssb-meme

Uses [flumeview-search](https://github.com/flumedb/flumeview-search) to build an index of all images names.

## Example Usage

```js
var Scuttlebot = require('scuttlebot')

Scuttlebot
  .use(require('scuttlebot/plugins/master'))
  .use(require('ssb-meme'))

var sbot = Scuttlebot(config) // see test/index.js for details

sbot.meme.search('hermes', (err, results) => {
  // ...
})
```


## API

### `sbot.meme.search(query, callback)`

- `query` must be a string at least 3 characters long
- `callback` recieves results as an object of form: 

```js
{
  '&234x234lass...': [
    { name: 'hermes-spade', author:'@ye+4...', msg: '%q24dad323...' }
    { name: 'hermes-wacka', author:'@mox5...', msg: '%asdasd696...' }
    //...
  ]
  //...
}
```

msg is the message where this mention occured

### `sbot.meme.query`

this is the raw method provided by flumeview-search. Not recommended for general use

---
_Source: https://npm.io/package/ssb-meme · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._