# brainshop

> A simple module to interact with the Brainshop.ai API.

Latest version **0.10.0** (published 2023-04-18) · MIT license · 0 weekly downloads

## Install

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

## Health

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

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.10.0 |
| Published | 2023-04-18 |
| First published | 2023-04-18 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Colderry |
| Maintainers | colderry |
| Keywords | brainshop, api, ai, brainshopai |

## Links

- npm: https://www.npmjs.com/package/brainshop
- Repository: https://github.com/colderry/brainshop
- Homepage: https://github.com/colderry/brainshop#readme
- Issues: https://github.com/colderry/brainshop/issues
- npm.io page: https://npm.io/package/brainshop

## Alternatives

- [@expo/fingerprint](https://npm.io/package/@expo/fingerprint.md) — 6.2M weekly downloads
- [@azure/monitor-opentelemetry-exporter](https://npm.io/package/@azure/monitor-opentelemetry-exporter.md) — 850.0K weekly downloads
- [@azure/monitor-opentelemetry](https://npm.io/package/@azure/monitor-opentelemetry.md) — 624.0K weekly downloads
- [@posthog/ai](https://npm.io/package/@posthog/ai.md) — 423.3K weekly downloads
- [fakefilter](https://npm.io/package/fakefilter.md) — 63.9K weekly downloads

## Recent versions

- 0.10.0 (latest) — 2023-04-18

## README

# brainshop
A simple module to interact with the [`Brainshop.ai`](https://brainshop.ai) API.

# Install
```
npm install brainshop
yarn add brainshop
```

# How to use
Import the `brainshop` module in your code.
```js
const Brainshop = require("brainshop");
```
Declare a variable constructing the `Brainshop` class.
Also Make sure to pass the Brain ID as `bid` and API Key as `key`.
```js
const brain = new Brainshop({
    bid: "174633",
    key: "vd372tjTuRsKdh1C"
});
```
To make the API call, you have to use the `get` method of Brainshop class. You will pass the `message` in the first parameter.
```js
brain.get("Hello Robot!").then((response) => {
    console.log(response); // { cnt: 'Hi, my friend, do you need me to do calculation for you?' }
});

// Or
brain.get("Hello Robot!", (response) => {
    console.log(response); // { cnt: 'Hi, my friend, do you need me to do calculation for you?' }
});
```
## Links
- The [Official Website](https://brainshop.ai) of Brainshop.
- The [Official Documentation](https://brainshop.ai/node/260731) of Brainshop API.
- The [GitHub Repo](https://github.com/colderry/brainshop) of this package.

## License
See the [LICENSE](./LICENSE) file.

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