discolink 1.3.0 → 2.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (6) hide show
  1. package/README.md +9 -14
  2. package/lib/index.d.mts +307 -820
  3. package/lib/index.d.ts +307 -820
  4. package/lib/index.js +703 -1232
  5. package/lib/index.mjs +703 -1231
  6. package/package.json +12 -8
package/README.md CHANGED
@@ -1,25 +1,19 @@
1
1
  <div align="center">
2
2
  <img alt="Discolink" src="assets/music-album.png" width="120" />
3
3
 
4
- [Icon designed by juicy_fish](https://www.flaticon.com/authors/juicy-fish)
4
+ [Icon by juicy_fish](https://www.flaticon.com/authors/juicy-fish)
5
5
  <br/>
6
- [Documentation](https://github.com/execaman/discolink/wiki) | [API Reference](https://execaman.github.io/discolink)
7
-
6
+ [API Reference](https://execaman.github.io/discolink) | [Coverage](http://app.codecov.io/gh/execaman/discolink)
7
+
8
8
  ![NPM Version](https://img.shields.io/npm/v/discolink?style=flat&logo=npm)
9
- ![NPM Downloads](https://img.shields.io/npm/dm/discolink)
9
+ ![Codecov Coverage](https://img.shields.io/codecov/c/github/execaman/discolink?label=codecov&logo=codecov)
10
+
10
11
  </div>
11
12
 
12
13
  ## 🎯 Purpose
13
14
 
14
15
  The goal of this library is to abstract away obvious steps involved in the process of acting as an intermediary between [Lavalink](https://lavalink.dev/api) and [Discord](https://discord.com/developers/docs/events/gateway) to give developers a cleaner yet intuitive interface to work with.
15
16
 
16
- ## ✨ Features
17
-
18
- - Built-in queue system
19
- - Automatic player relocation
20
- - Built-in custom plugin support
21
- - Automatic relevant-node selection
22
-
23
17
  ## ⚙️ Requirements
24
18
 
25
19
  - **Runtime** - one of the following:
@@ -59,7 +53,8 @@ client.on("raw", (payload) => {
59
53
  client.login();
60
54
  ```
61
55
 
62
- ## 📝 Additional Notes
56
+ ## 📝 Implementation
63
57
 
64
- - Handle track end reasons other than `cleanup` and `finished` manually
65
- - Always check for `reconnecting` or `changingNode` when handling voice states
58
+ - Handle track end reasons other than `cleanup` and `finished`
59
+ - Handle voice states with care, e.g. `reconnecting`, `changingNode`, etc.
60
+ - Handle queue destruction/relocation, e.g. guild/channel delete, node close/disconnect, etc.