# wdsdk

> An SDK for alimosallaei19/Watch_Dog.

Latest version **1.2.2** (published 2022-12-26) · ISC license · 0 weekly downloads

## Install

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

## 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.2 |
| Published | 2022-12-26 |
| First published | 2022-03-25 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 5.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | alimosallaei |
| Keywords | watch_dog |

## Links

- npm: https://www.npmjs.com/package/wdsdk
- npm.io page: https://npm.io/package/wdsdk

## Dependencies (1)

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

## Recent versions

- 1.2.2 (latest) — 2022-12-26
- 1.2.1 — 2022-12-26
- 1.2.0 — 2022-12-26
- 1.1.1 — 2022-04-02
- 1.1.0 — 2022-04-01
- 1.0.6 — 2022-03-26
- 1.0.5 — 2022-03-26
- 1.0.4 — 2022-03-26
- 1.0.3 — 2022-03-25
- 1.0.2 — 2022-03-25
- 1.0.1 — 2022-03-25
- 1.0.0 — 2022-03-25

## README

## Watch_Dog SDK

> **NOTE**: This SDK should *only* be used if you have access to [alimosallaei19/Watch_Dog](https://github.com/alimosallaei19/Watch_dog). Otherwise, there is no point.

Watch_Dog is a vTerminal/error handling system that connects to a Discord bot. Basically, if you're running Cron Jobs, you can use this SDK to interact with Watch_Dog to output terminal actions for your records. 

### Installation

```bash
npm install @alimosallaei/wdsdk
```
```js
// app.js
const wd = require('wdsdk')
```

### Usage
> `.create()`: Creates a new vTerminal instance. In Discord, this creates a new channel. Returns the `id` of the channel.

---

> `.send(id, msg)`: Send a message to the vTerminal channel. `id` and `msg` should both be strings. Returns `true` if properly executed. 

---

> `.close(id)`: Closes the vTerminal instance. This will rename the terminal and move it out of the live queue. Returns the `name` of the channel.

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