# basicset-chronicler

> A module that creates a persistent topic-centric record of an app's interactions with Twitter users.

Latest version **3.1.0** (published 2016-11-14) · MIT license · 0 weekly downloads

## Install

```sh
npm install basicset-chronicler
pnpm add basicset-chronicler
yarn add basicset-chronicler
bun add basicset-chronicler
```

## 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 | 3.1.0 |
| Published | 2016-11-14 |
| First published | 2014-12-18 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Known vulnerabilities | 0 (+5 in 1 direct dependencies) |
| Install scripts | no |
| Author | Jim Kang |
| Maintainers | jimkang |
| Keywords | database, record, twitter |

## Links

- npm: https://www.npmjs.com/package/basicset-chronicler
- Repository: https://github.com/jimkang/chronicler
- Issues: https://github.com/jimkang/chronicler/issues
- npm.io page: https://npm.io/package/basicset-chronicler

## Dependencies (3)

- [lodash](https://npm.io/package/lodash.md) ^2.4.1
- [canonicalizer](https://npm.io/package/canonicalizer.md) ^1.0.1
- [basicset-levelwrap](https://npm.io/package/basicset-levelwrap.md) ^0.3.1

## Recent versions

- 3.1.0 (latest) — 2016-11-14
- 3.0.0 — 2016-08-26
- 2.0.0 — 2016-01-29
- 1.3.1 — 2015-10-01
- 1.3.0 — 2015-03-01
- 1.2.0 — 2014-12-20
- 1.1.0 — 2014-12-20
- 1.0.0 — 2014-12-18

## README

chronicler
==================

A module that creates a persistent topic-centric record of an app's interactions with Twitter users.

Etc.!

Installation
------------

    npm install basicset-chronicler

Usage
-----

Create an instance:

    var Chronicler = require('basicset-chronicler');
    var chronicler = Chronicler({
      db: 'appname.db'
    });

Warning/TODO: createChronicler should actually be async, but is not. It's not safe to use it until the next tick.

Record that a tweet was replied to.

    chronicler.recordThatTweetWasRepliedTo(tweetId, logError);

      function logError(error) {
        if (error) {
          console.log(error);
        }
      }

Find out if a tweet was replied to.

    chronicler.tweetWasRepliedTo(tweetId, function done(error, replied) {
      if (replied) {
        console.log('Tweet', tweetId, 'was replied to.');
      }
    });

Find out if a topic has been discussed with a Twitter user.

    chronicler.topicWasUsedInTribute('jerks', 'someuserid', reportUsed);

    function reportUsed(error, wasUsed) {
      if (wasUsed) {
        console.log('jerks were discussed with user someuserid.');
      }
    }

Find out how many times a topic has been discussed with a Twitter user.

    chronicler.timesTopicWasUsedInTribute('jerks', 'someuserid', reportUsed);

    function reportUsed(error, count) {
      console.log('jerks were discussed with user someuserid', count, 'times.');
    }

Tests
-----

Run tests with `make test`.

License
-------

MIT.

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