# ketchupjs

> Lightweight javascript library for tracking analytical data that you care about

Latest version **1.2.5** (published 2019-03-23) · ISC license · 0 weekly downloads

## Install

```sh
npm install ketchupjs
pnpm add ketchupjs
yarn add ketchupjs
bun add ketchupjs
```

## 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.2.5 |
| Published | 2019-03-23 |
| First published | 2019-03-13 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 5.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Kevin Tauzer, Brad McKinney, Tyler McFarland |
| Maintainers | newbology |
| Keywords | data, analytics, javascript |

## Links

- npm: https://www.npmjs.com/package/ketchupjs
- Repository: https://github.com/Newbology/ketchupjs-lib
- Homepage: https://github.com/Newbology/ketchupjs-lib#readme
- Issues: https://github.com/Newbology/ketchupjs-lib/issues
- npm.io page: https://npm.io/package/ketchupjs

## Dependencies (1)

- [node-fetch](https://npm.io/package/node-fetch.md) ^2.3.0

## Alternatives

- [gamedig](https://npm.io/package/gamedig.md) — 29.3K weekly downloads
- [join-monster](https://npm.io/package/join-monster.md) — 12.8K weekly downloads
- [masked](https://npm.io/package/masked.md) — 5.5K weekly downloads
- [@comunica/actor-query-process-explain-logical](https://npm.io/package/@comunica/actor-query-process-explain-logical.md) — 4.7K weekly downloads
- [@veracity/vui](https://npm.io/package/@veracity/vui.md) — 4.6K weekly downloads

## Recent versions

- 1.2.5 (latest) — 2019-03-23
- 1.2.4 — 2019-03-19
- 1.2.3 — 2019-03-15
- 1.2.2 — 2019-03-15
- 1.2.0 — 2019-03-15
- 1.0.5 — 2019-03-14
- 1.0.4 — 2019-03-13
- 1.0.3 — 2019-03-13
- 1.0.2 — 2019-03-13
- 1.0.1 — 2019-03-13
- 1.0.0 — 2019-03-13

## README

# KetchupJS
Our target is to make it easier for both large and small business owners to record analytical data. We created a library to use in your app to do that. Just use our library you want to record a piece of data in your code base, and view your analytics at <a href="http://www.ketchupjs.dev">ketchupjs.dev</a>.


## Quick Start
First, signup at <a href="https://www.ketchupjs.dev">ketchupjs.dev</a> you will recieve a secret **api key** in order to use our service. **DO NOT** share this with anyone else.


After signing up and getting your **api key** run 
`$ npm install ketchupjs`.

## Using KetchupJS

```
const ketchup = require('ketchupjs')

ketchup.config("api_key")
```

```
ketchup.save( metric, value, [user_name, [public]])
```

```
ketchup.most( metric, value, [user_name, [public]])
```
## Parameters
| Name | Type  | Description |
|------|-------| :----------:|
|api key |String| Key provided when account is created |
| metric | String | Name of what you want to be recorded (Required) |
| value | Number | Amount of metric to be recorded (Required)| 
| user_name | String | [Optional] Attaches metric and value to certain user|
| public | String | [Requires user_name[Optional]] Makes data either public or private, defaults to setting on profile.|

## Examples
**config** sets api key to allows access to use our service.
```
ketchup.config("XXXXXXX-XXXXXXX-XXXXXXX-XXXXXXX")
```
**save** records an event of the **metric** and its **value**.
```
ketchup.save("sales", 2.49)
```
You can assign the recorded event to a certain user by specifying their **user_name**.
```
ketchup.save("sales", 2.49, "User1")
```
By setting **public** to false you can prevent anyone from viewing this data through our service at <a href="http://www.ketchupjs.dev">ketchupjs.dev</a> (defaulted to true, this can be changed in your profile settings). 
```
ketchup.save("sales", 2.49, "User1", false)
```
**most** records the highest **value** and overwrites any previous lesser recorded  **value** for the specified **metric**. 
```
ketchup.most("daily_spending", 4.92, "User1", false)
```
Ex. if the **value** of **daily_spending** was greater than the **valueStored**, the event would be recorded, but if it were less than the **valueStored** it would not be recorded:
```
if(value > valueStored) {
  valueStored = value
};
```

This library does not work for browser based applications, Go to  <a href="http://www.ketchupjs.dev">ketchupjs</a>  to learn more about using our Content delivery network(CDN).

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