# discord-friends

> discord-friends est un module NPM permettant d'ajouter des amis et d'être tenu au courant des évènements sélectionnés les concernant.

Latest version **2.0.0** (published 2020-08-08) · ISC license · 0 weekly downloads

## Install

```sh
npm install discord-friends
pnpm add discord-friends
yarn add discord-friends
bun add discord-friends
```

## 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 | 2.0.0 |
| Published | 2020-08-08 |
| First published | 2020-08-06 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 16.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Nyfos |
| Maintainers | nyfos |
| Keywords | discord, discord.js, friend, friends, nyfos |

## Links

- npm: https://www.npmjs.com/package/discord-friends
- Repository: https://github.com/Nyfos/discord-friends
- Homepage: https://github.com/Nyfos/discord-friends#readme
- Issues: https://github.com/Nyfos/discord-friends/issues
- npm.io page: https://npm.io/package/discord-friends

## Dependencies (1)

- [discord.js](https://npm.io/package/discord.js.md) ^11.5.1

## Recent versions

- 2.0.0 (latest) — 2020-08-08
- 1.0.1 — 2020-08-08
- 1.0.0 — 2020-08-06

## README

<div align="center">
  <p>
    <a href="https://discord.gg/q6eMWS2"><img src="https://discordapp.com/api/guilds/616371260569681930/embed.png" alt="Serveur Discord" /></a>
    <a href="https://www.npmjs.com/package/discord-friends"><img src="https://img.shields.io/npm/v/discord-friends.svg?maxAge=3600" alt="Version NPM" /></a>
    <a href="https://www.npmjs.com/package/discord-friends"><img src="https://img.shields.io/npm/dt/discord-friends.svg?maxAge=3600" alt="Téléchargements NPM" /></a>
  </p>
  <p>
    <a href="https://nodei.co/npm/discord-friends/"><img src="https://nodei.co/npm/discord-friends.png?downloads=true&stars=true" alt="Informations NPM" /></a>
  </p>
</div>

## À propos
discord-friends est un module NPM permettant d'ajouter des amis et d'être tenu au courant des évènements sélectionnés relatifs à vos amis.

Disponible avec Discord.js V11 et V12.

- Simple d'utilisation
- Utile
- Rapide mise en place

## Installation

`npm install discord-friends`

## Exemple d'utilisation
```js
const Discord = require("discord.js")
const client = new Discord.Client();

const discordfriends = require("discord-friends");
var options = {
  friendConnection: "L'un de vos amis vient de se connecter !",
  ignoredUsers: [481077432452120586, 456226577798135808]
}
var DiscordFriends = new discordfriends(client, options)

DiscordFriends.on('newFriend', (userID, friendID, options) => {
  console.log(`${userID} a ajouté un ami, ${friendID}.`)
})

client.login("token")
```

## Options

| Option              |              Description              |                    Type |   Default |
| :------------------ | :-----------------------------------: | ----------------------: | --------: |
| `maxFriends`        |     Maximum d'amis par utilisateur    |  Number [-1 = illimité] |      `-1` |
| `statusDetection`   |  Détection des changements de statut  |                 Boolean |    `true` |
| `mentionDetection`  | Détection des mentions d'utilisateurs |                 Boolean |    `true` |
| `mentions`          |      Mentions en messages privés      |                 Boolean |    `true` |
| `friendConnect`     |         Message de connection         |                  String |   Voir "1 |
| `friendDisconnect`  |        Message de déconnection        |                  String |   Voir "2 |
| `mentionned`        |          Message de mentions          |                  String |   Voir "3 |
| `mentionIfConnect`  |               Voir "4                 |                 Boolean |    `true` |
| `usersFriends`      |             Liste d'amis              |                   Array |      `{}` |
| `ignoredUsers`      |     Liste d'utilisateurs à ignorer    |                  Object |      `[]` |

"1 : `"one of your friends just connected!"`

"2 : `"one of your friends just disconnected!"`

"3 : `"one of your friends just mention you!"`

"4 : `Envoyer des messages privés uniquement si l'utilisateur concerné est connecté`

## Méthodes

| Méthode                          |                           Description |
| :------------------------------- | ------------------------------------: |
| `.add(id, friendID, options)`    |                         Ajoute un ami |
| `.remove(id, friendID)`          |                       Supprime un ami |
| `.update(id, friendID, options)` |                     Met à jour un ami |
| `.users()`                       |     Obtenir la liste des utilisateurs |
| `.clear()`                       |   Supprimer la liste des utilisateurs |

## Events

| Évènement           | Description                                                    |
| :------------------ | :------------------------------------------------------------- |
| `newFriend`         | Émis quand une nouvelle paire utilisateur-ami est créée        |
| `removeFriend`      | Émis quand une paire utilisateur-ami est supprimée             |
| `updateFriend`      | Émis quand une paire utilisateur-ami est mise à jour           |
| `userListRetrieved` | Émis quand la méthode `.users()` est appellée                  |
| `cleared`           | Émis quand la liste des paires utilisateurs-amis est supprimée |

*La liste des réponses des évènements est disponible ci-dessous*

## Réponses Events

| Évènement           | Réponse                                             |
| :------------------ | :-------------------------------------------------- |
| `newFriend`         | `( id, idAmi, optionsAmi, pairesUtilisateursAmis )` |
| `removeFriend`      | `( id, idAmi, pairesUtilisateursAmis )`             |
| `updateFriend`      | `( id, idAmi, optionsAmi, pairesUtilisateursAmis )` |
| `userListRetrieved` | `( pairesUtilisateursAmis )`                        |
| `cleared`           | `( pairesUtilisateursAmis )`                        |

## Liens

* [GitHub](https://github.com/Nyfos/discord-friends)
* [NPM](https://www.npmjs.com/package/discord-friends)

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