# discord-client-api

> A lightweight Discord API class

Latest version **1.0.4** (published 2019-02-17) · ISC license · 0 weekly downloads

## Install

```sh
npm install discord-client-api
pnpm add discord-client-api
yarn add discord-client-api
bun add discord-client-api
```

## 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.0.4 |
| Published | 2019-02-17 |
| First published | 2019-02-09 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 8 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 8 |
| Author | jakemadness |
| Maintainers | jakemadness |
| Keywords | discord, client, api, class |

## Links

- npm: https://www.npmjs.com/package/discord-client-api
- Repository: https://github.com/jakemadness/discord-client-api
- Homepage: https://github.com/jakemadness/discord-client-api/blob/master/nodejs/README.md
- Issues: https://github.com/jakemadness/discord-client-api/issues
- npm.io page: https://npm.io/package/discord-client-api

## Dependencies (1)

- [request](https://npm.io/package/request.md) ^2.88.0

## Alternatives

- [launchdarkly-js-client-sdk](https://npm.io/package/launchdarkly-js-client-sdk.md) — 2.5M weekly downloads
- [@elastic/elasticsearch](https://npm.io/package/@elastic/elasticsearch.md) — 2.1M weekly downloads
- [@c8y/client](https://npm.io/package/@c8y/client.md) — 15.3K weekly downloads
- [@signaldb/maverickjs](https://npm.io/package/@signaldb/maverickjs.md) — 1.7K weekly downloads
- [@bbc/http-transport-cache](https://npm.io/package/@bbc/http-transport-cache.md) — 1.2K weekly downloads

## Recent versions

- 1.0.4 (latest) — 2019-02-17
- 1.0.3 — 2019-02-09
- 1.0.2 — 2019-02-09
- 1.0.1 — 2019-02-09
- 1.0.0 — 2019-02-09

## README

<div align="center">
  <p>
    <a href="https://nodei.co/npm/discord-client-api/"><img src="https://nodei.co/npm/discord-client-api.png?downloads=true&stars=true" alt="NPM info" /></a>
  </p>
</div>

# Discord Client API
discord-client-api works by requiring the package in your NodeJS file then calling its functions.

## Installation
To install the package type the following:
```
npm install discord-client-api
```

## Getting Started
Require the discord-client-api module and create an instance of the API like the following example:

```JS
var client = new (require('discord-client-api'))('discord token');
```

## API Methods
**Join Server:**
```JS
client.joinServer('invite code', function(data) {
   console.log(data);
});
```

**Leave Server:**
```JS
client.leaveServer('server id', function(data) {
   console.log(data);
});
```

**Get Servers:**
```JS
client.getServers(function(data) {
   console.log(data);
});
```

**Send Message:**
```JS
client.sendMessage('channel id', 'message', function(data) {
   console.log(data);
});
```

**Delete Message:**
```JS
client.deleteMessage('channel id', 'message id', function(data) {
   console.log(data);
});
```

**Get Messages:**
```JS
client.getMessages('channel id', 25, function(data) {
   console.log(data);
});
```

**Add Reaction:**
```JS
client.addReaction('channel id', 'message id', '🐢', function(data) {
   console.log(data);
});
```

**Remove Reaction:**
```JS
client.removeReaction('channel id', 'message id', '🐢', function(data) {
   console.log(data);
});
```

**Is Typing:**
```JS
client.isTyping('channel id', function(data) {
   console.log(data);
});
```

**Change Nickname:**
```JS
client.changeNickname('server id', 'new nickname', function(data) {
   console.log(data);
});
```

**Update Status:**
```JS
client.updateStatus('dnd', function(data) {
   console.log(data);
});
```

**Update User Settings:**
```JS
client.updateUserSettings('username', 'email', 'password', 'new password', 'data:image/jpeg;base64,Hq..', function(data) {
   console.log(data);
});
```

**Create Server:**
```JS
client.createServer('server name', 'eu-west', 'data:image/jpeg;base64,H8q..', function(data) {
   console.log(data);
});
```

**Delete Server:**
```JS
client.deleteServer('server id', function(data) {
   console.log(data);
});
```

**Create Channel:**
```JS
client.createChannel('server id', 'channel name', 'channel parent id', 'channel type', function(data) {
   console.log(data);
});
```

**Delete Channel:**
```JS
client.deleteChannel('channel id', function(data) {
   console.log(data);
});
```

**Create Role:**
```JS
client.createRole('server id', function(data) {
   console.log(data);
});
```

**Delete Role:**
```JS
client.deleteRole('server id', 'role id', function(data) {
   console.log(data);
});
```

**Join Hypesquad:**
```JS
client.joinHypesquad(1, function(data) {
   console.log(data);
});
```

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