chore: regen api docs

shipgirlproject · Aug 13, 2024 · b353edb · b353edb
1 parent 13401c1
commit b353edb
Show file tree

Hide file tree

Showing 91 changed files with 1,765 additions and 818 deletions.
diff --git a/src/content/docs/api/README.md b/src/content/docs/api/README.md
@@ -29,6 +29,7 @@ title: "shoukaku"
 | [Node](/api/classes/node/) | Represents a Lavalink node |
 | [Player](/api/classes/player/) | Wrapper object around Lavalink |
 | [Rest](/api/classes/rest/) | Wrapper around Lavalink REST API |
+| [RestError](/api/classes/resterror/) | - |
 | [Shoukaku](/api/classes/shoukaku/) | Main Shoukaku class |
 
 ## Interfaces
@@ -48,12 +49,13 @@ title: "shoukaku"
 | [KaraokeSettings](/api/interfaces/karaokesettings/) | - |
 | [LavalinkPlayer](/api/interfaces/lavalinkplayer/) | - |
 | [LavalinkPlayerVoice](/api/interfaces/lavalinkplayervoice/) | - |
-| [LavalinkPlayerVoiceOptions](/api/interfaces/lavalinkplayervoiceoptions/) | - |
 | [LowPassSettings](/api/interfaces/lowpasssettings/) | - |
+| [NodeInfo](/api/interfaces/nodeinfo/) | - |
+| [NodeInfoGit](/api/interfaces/nodeinfogit/) | - |
+| [NodeInfoPlugin](/api/interfaces/nodeinfoplugin/) | - |
+| [NodeInfoVersion](/api/interfaces/nodeinfoversion/) | - |
 | [NodeOption](/api/interfaces/nodeoption/) | - |
-| [NonResumableHeaders](/api/interfaces/nonresumableheaders/) | - |
 | [PlayerEvent](/api/interfaces/playerevent/) | - |
-| [PlayerEvents](/api/interfaces/playerevents/) | - |
 | [PlayerUpdate](/api/interfaces/playerupdate/) | - |
 | [Playlist](/api/interfaces/playlist/) | - |
 | [PlaylistResult](/api/interfaces/playlistresult/) | - |
@@ -64,7 +66,6 @@ title: "shoukaku"
 | [SearchResult](/api/interfaces/searchresult/) | - |
 | [ServerUpdate](/api/interfaces/serverupdate/) | Represents the payload from a serverUpdate event |
 | [SessionInfo](/api/interfaces/sessioninfo/) | - |
-| [ShoukakuEvents](/api/interfaces/shoukakuevents/) | - |
 | [ShoukakuOptions](/api/interfaces/shoukakuoptions/) | - |
 | [StateUpdatePartial](/api/interfaces/stateupdatepartial/) | Represents the partial payload from a stateUpdate event |
 | [Stats](/api/interfaces/stats/) | - |
@@ -86,14 +87,15 @@ title: "shoukaku"
 
 | Type alias | Description |
 | ------ | ------ |
+| [LavalinkPlayerVoiceOptions](/api/type-aliases/lavalinkplayervoiceoptions/) | - |
 | [LavalinkResponse](/api/type-aliases/lavalinkresponse/) | - |
-| [NodeInfo](/api/type-aliases/nodeinfo/) | - |
-| [NodeInfoGit](/api/type-aliases/nodeinfogit/) | - |
-| [NodeInfoPlugin](/api/type-aliases/nodeinfoplugin/) | - |
-| [NodeInfoVersion](/api/type-aliases/nodeinfoversion/) | - |
+| [NodeEvents](/api/type-aliases/nodeevents/) | - |
+| [NonResumableHeaders](/api/type-aliases/nonresumableheaders/) | - |
 | [PlayOptions](/api/type-aliases/playoptions/) | - |
+| [PlayerEvents](/api/type-aliases/playerevents/) | - |
 | [ResumeOptions](/api/type-aliases/resumeoptions/) | - |
 | [Severity](/api/type-aliases/severity/) | - |
+| [ShoukakuEvents](/api/type-aliases/shoukakuevents/) | - |
 | [TrackEndReason](/api/type-aliases/trackendreason/) | - |
 
 ## Variables

diff --git a/src/content/docs/api/classes/Connection.md b/src/content/docs/api/classes/Connection.md
@@ -38,7 +38,7 @@ new Connection(manager: Shoukaku, options: VoiceChannelOptions): Connection
 
 #### Defined in
 
-[guild/Connection.ts:86](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Connection.ts#L86)
+[shoukaku/src/guild/Connection.ts:85](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Connection.ts#L85)
 
 ## Properties
 
@@ -54,7 +54,7 @@ VoiceChannelId of the connection that is being managed by this instance
 
 #### Defined in
 
-[guild/Connection.ts:39](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Connection.ts#L39)
+[shoukaku/src/guild/Connection.ts:39](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Connection.ts#L39)
 
 ***
 
@@ -70,7 +70,7 @@ Deafen status in connected voice channel
 
 #### Defined in
 
-[guild/Connection.ts:52](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Connection.ts#L52)
+[shoukaku/src/guild/Connection.ts:51](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Connection.ts#L51)
 
 ***
 
@@ -86,7 +86,7 @@ GuildId of the connection that is being managed by this instance
 
 #### Defined in
 
-[guild/Connection.ts:35](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Connection.ts#L35)
+[shoukaku/src/guild/Connection.ts:35](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Connection.ts#L35)
 
 ***
 
@@ -102,7 +102,7 @@ Id of the voice channel where this instance was connected before the current cha
 
 #### Defined in
 
-[guild/Connection.ts:56](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Connection.ts#L56)
+[shoukaku/src/guild/Connection.ts:55](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Connection.ts#L55)
 
 ***
 
@@ -118,7 +118,7 @@ Last region of the connected voice channel
 
 #### Defined in
 
-[guild/Connection.ts:68](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Connection.ts#L68)
+[shoukaku/src/guild/Connection.ts:67](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Connection.ts#L67)
 
 ***
 
@@ -134,7 +134,7 @@ The manager where this connection is on
 
 #### Defined in
 
-[guild/Connection.ts:31](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Connection.ts#L31)
+[shoukaku/src/guild/Connection.ts:31](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Connection.ts#L31)
 
 ***
 
@@ -150,7 +150,7 @@ Mute status in connected voice channel
 
 #### Defined in
 
-[guild/Connection.ts:48](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Connection.ts#L48)
+[shoukaku/src/guild/Connection.ts:47](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Connection.ts#L47)
 
 ***
 
@@ -166,7 +166,7 @@ Region of connected voice channel
 
 #### Defined in
 
-[guild/Connection.ts:64](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Connection.ts#L64)
+[shoukaku/src/guild/Connection.ts:63](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Connection.ts#L63)
 
 ***
 
@@ -182,7 +182,7 @@ Cached serverUpdate event from Lavalink
 
 #### Defined in
 
-[guild/Connection.ts:72](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Connection.ts#L72)
+[shoukaku/src/guild/Connection.ts:71](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Connection.ts#L71)
 
 ***
 
@@ -198,7 +198,7 @@ Id of the currently active voice channel connection
 
 #### Defined in
 
-[guild/Connection.ts:60](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Connection.ts#L60)
+[shoukaku/src/guild/Connection.ts:59](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Connection.ts#L59)
 
 ***
 
@@ -214,7 +214,7 @@ ShardId where this connection sends data on
 
 #### Defined in
 
-[guild/Connection.ts:44](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Connection.ts#L44)
+[shoukaku/src/guild/Connection.ts:43](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Connection.ts#L43)
 
 ***
 
@@ -230,7 +230,7 @@ Connection state
 
 #### Defined in
 
-[guild/Connection.ts:76](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Connection.ts#L76)
+[shoukaku/src/guild/Connection.ts:75](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Connection.ts#L75)
 
 ## Methods
 
@@ -262,7 +262,7 @@ false
 
 #### Defined in
 
-[guild/Connection.ts:107](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Connection.ts#L107)
+[shoukaku/src/guild/Connection.ts:106](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Connection.ts#L106)
 
 ***
 
@@ -294,4 +294,4 @@ false
 
 #### Defined in
 
-[guild/Connection.ts:117](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Connection.ts#L117)
+[shoukaku/src/guild/Connection.ts:116](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Connection.ts#L116)
diff --git a/src/content/docs/api/classes/Connector.md b/src/content/docs/api/classes/Connector.md
@@ -34,7 +34,7 @@ new Connector(client: any): Connector
 
 #### Defined in
 
-[connectors/Connector.ts:15](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/connectors/Connector.ts#L15)
+[shoukaku/src/connectors/Connector.ts:17](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/connectors/Connector.ts#L17)
 
 ## Methods
 
@@ -52,7 +52,7 @@ abstract getId(): string
 
 #### Defined in
 
-[connectors/Connector.ts:41](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/connectors/Connector.ts#L41)
+[shoukaku/src/connectors/Connector.ts:44](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/connectors/Connector.ts#L44)
 
 ***
 
@@ -76,7 +76,7 @@ abstract listen(nodes: NodeOption[]): void
 
 #### Defined in
 
-[connectors/Connector.ts:45](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/connectors/Connector.ts#L45)
+[shoukaku/src/connectors/Connector.ts:48](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/connectors/Connector.ts#L48)
 
 ***
 
@@ -87,7 +87,7 @@ abstract listen(nodes: NodeOption[]): void
 ```ts
 abstract sendPacket(
    shardId: number, 
-   payload: any, 
+   payload: unknown, 
    important: boolean): void
 ```
 
@@ -96,7 +96,7 @@ abstract sendPacket(
 | Parameter | Type |
 | ------ | ------ |
 | `shardId` | `number` |
-| `payload` | `any` |
+| `payload` | `unknown` |
 | `important` | `boolean` |
 
 #### Returns
@@ -105,7 +105,7 @@ abstract sendPacket(
 
 #### Defined in
 
-[connectors/Connector.ts:43](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/connectors/Connector.ts#L43)
+[shoukaku/src/connectors/Connector.ts:46](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/connectors/Connector.ts#L46)
 
 ***
 
@@ -129,4 +129,4 @@ set(manager: Shoukaku): Connector
 
 #### Defined in
 
-[connectors/Connector.ts:20](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/connectors/Connector.ts#L20)
+[shoukaku/src/connectors/Connector.ts:23](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/connectors/Connector.ts#L23)