From b353edb44722a6c6c5fdb4212befc6eaad7420a7 Mon Sep 17 00:00:00 2001 From: 0t4u <61939142+0t4u@users.noreply.github.com> Date: Tue, 13 Aug 2024 17:31:31 +0800 Subject: [PATCH] chore: regen api docs --- src/content/docs/api/README.md | 18 +- src/content/docs/api/classes/Connection.md | 30 +- src/content/docs/api/classes/Connector.md | 14 +- src/content/docs/api/classes/Node.md | 286 ++++++++++++++++-- src/content/docs/api/classes/Player.md | 246 +++++++++++---- src/content/docs/api/classes/Rest.md | 26 +- src/content/docs/api/classes/RestError.md | 162 ++++++++++ src/content/docs/api/classes/Shoukaku.md | 206 ++++++++++--- src/content/docs/api/enumerations/LoadType.md | 10 +- .../docs/api/enumerations/PlayerEventType.md | 10 +- src/content/docs/api/interfaces/Address.md | 6 +- src/content/docs/api/interfaces/Band.md | 4 +- .../docs/api/interfaces/ChannelMixSettings.md | 8 +- .../docs/api/interfaces/ConnectorMethods.md | 4 +- .../docs/api/interfaces/DistortionSettings.md | 16 +- .../docs/api/interfaces/EmptyResult.md | 6 +- .../docs/api/interfaces/ErrorResult.md | 4 +- src/content/docs/api/interfaces/Exception.md | 6 +- .../docs/api/interfaces/FilterOptions.md | 20 +- .../docs/api/interfaces/FreqSettings.md | 4 +- .../docs/api/interfaces/KaraokeSettings.md | 8 +- .../docs/api/interfaces/LavalinkPlayer.md | 12 +- .../api/interfaces/LavalinkPlayerVoice.md | 10 +- .../interfaces/LavalinkPlayerVoiceOptions.md | 64 ---- .../docs/api/interfaces/LowPassSettings.md | 2 +- src/content/docs/api/interfaces/NodeInfo.md | 118 ++++++++ .../docs/api/interfaces/NodeInfoGit.md | 48 +++ .../docs/api/interfaces/NodeInfoPlugin.md | 34 +++ .../docs/api/interfaces/NodeInfoVersion.md | 90 ++++++ src/content/docs/api/interfaces/NodeOption.md | 10 +- .../api/interfaces/NonResumableHeaders.md | 10 - .../docs/api/interfaces/PlayerEvent.md | 4 +- .../docs/api/interfaces/PlayerEvents.md | 118 -------- .../docs/api/interfaces/PlayerUpdate.md | 6 +- src/content/docs/api/interfaces/Playlist.md | 8 +- .../docs/api/interfaces/PlaylistResult.md | 4 +- src/content/docs/api/interfaces/Ready.md | 6 +- .../docs/api/interfaces/ResumableHeaders.md | 10 +- .../docs/api/interfaces/RotationSettings.md | 2 +- .../docs/api/interfaces/RoutePlanner.md | 4 +- .../docs/api/interfaces/SearchResult.md | 4 +- .../docs/api/interfaces/ServerUpdate.md | 6 +- .../docs/api/interfaces/SessionInfo.md | 4 +- .../docs/api/interfaces/ShoukakuEvents.md | 118 -------- .../docs/api/interfaces/ShoukakuOptions.md | 22 +- .../docs/api/interfaces/StateUpdatePartial.md | 8 +- src/content/docs/api/interfaces/Stats.md | 14 +- src/content/docs/api/interfaces/Structures.md | 4 +- .../docs/api/interfaces/TimescaleSettings.md | 6 +- src/content/docs/api/interfaces/Track.md | 6 +- .../docs/api/interfaces/TrackEndEvent.md | 10 +- .../api/interfaces/TrackExceptionEvent.md | 8 +- .../docs/api/interfaces/TrackResult.md | 4 +- .../docs/api/interfaces/TrackStartEvent.md | 8 +- .../docs/api/interfaces/TrackStuckEvent.md | 10 +- .../docs/api/interfaces/UpdatePlayerInfo.md | 6 +- .../api/interfaces/UpdatePlayerOptions.md | 14 +- .../interfaces/UpdatePlayerTrackOptions.md | 6 +- .../api/interfaces/VoiceChannelOptions.md | 10 +- .../api/interfaces/WebSocketClosedEvent.md | 12 +- .../Connectors/classes/DiscordJS.md | 10 +- .../api/namespaces/Connectors/classes/Eris.md | 10 +- .../Connectors/classes/OceanicJS.md | 10 +- .../namespaces/Connectors/classes/Seyfert.md | 14 +- .../Constants/enumerations/OpCodes.md | 8 +- .../Constants/enumerations/State.md | 12 +- .../Constants/enumerations/Versions.md | 13 - .../Constants/enumerations/VoiceState.md | 8 +- .../Constants/variables/NodeDefaults.md | 2 +- .../Constants/variables/ShoukakuClientInfo.md | 14 + .../Constants/variables/ShoukakuDefaults.md | 2 +- .../Constants/variables/Versions.md | 24 ++ .../Utils/classes/TypedEventEmitter.md | 270 +++++++++++++++++ .../Utils/functions/mergeDefault.md | 4 +- .../api/namespaces/Utils/functions/wait.md | 2 +- .../Utils/type-aliases/Constructor.md | 6 +- .../LavalinkPlayerVoiceOptions.md | 14 + .../docs/api/type-aliases/LavalinkResponse.md | 2 +- .../docs/api/type-aliases/NodeEvents.md | 14 + src/content/docs/api/type-aliases/NodeInfo.md | 36 --- .../docs/api/type-aliases/NodeInfoGit.md | 26 -- .../docs/api/type-aliases/NodeInfoPlugin.md | 24 -- .../docs/api/type-aliases/NodeInfoVersion.md | 32 -- .../api/type-aliases/NonResumableHeaders.md | 14 + .../docs/api/type-aliases/PlayOptions.md | 2 +- .../docs/api/type-aliases/PlayerEvents.md | 34 +++ .../docs/api/type-aliases/ResumeOptions.md | 2 +- src/content/docs/api/type-aliases/Severity.md | 2 +- .../docs/api/type-aliases/ShoukakuEvents.md | 34 +++ .../docs/api/type-aliases/TrackEndReason.md | 2 +- .../docs/api/variables/AllowedPackets.md | 2 +- 91 files changed, 1765 insertions(+), 818 deletions(-) create mode 100644 src/content/docs/api/classes/RestError.md delete mode 100644 src/content/docs/api/interfaces/LavalinkPlayerVoiceOptions.md create mode 100644 src/content/docs/api/interfaces/NodeInfo.md create mode 100644 src/content/docs/api/interfaces/NodeInfoGit.md create mode 100644 src/content/docs/api/interfaces/NodeInfoPlugin.md create mode 100644 src/content/docs/api/interfaces/NodeInfoVersion.md delete mode 100644 src/content/docs/api/interfaces/NonResumableHeaders.md delete mode 100644 src/content/docs/api/interfaces/PlayerEvents.md delete mode 100644 src/content/docs/api/interfaces/ShoukakuEvents.md delete mode 100644 src/content/docs/api/namespaces/Constants/enumerations/Versions.md create mode 100644 src/content/docs/api/namespaces/Constants/variables/ShoukakuClientInfo.md create mode 100644 src/content/docs/api/namespaces/Constants/variables/Versions.md create mode 100644 src/content/docs/api/namespaces/Utils/classes/TypedEventEmitter.md create mode 100644 src/content/docs/api/type-aliases/LavalinkPlayerVoiceOptions.md create mode 100644 src/content/docs/api/type-aliases/NodeEvents.md delete mode 100644 src/content/docs/api/type-aliases/NodeInfo.md delete mode 100644 src/content/docs/api/type-aliases/NodeInfoGit.md delete mode 100644 src/content/docs/api/type-aliases/NodeInfoPlugin.md delete mode 100644 src/content/docs/api/type-aliases/NodeInfoVersion.md create mode 100644 src/content/docs/api/type-aliases/NonResumableHeaders.md create mode 100644 src/content/docs/api/type-aliases/PlayerEvents.md create mode 100644 src/content/docs/api/type-aliases/ShoukakuEvents.md diff --git a/src/content/docs/api/README.md b/src/content/docs/api/README.md index 9c2b497..8bb511a 100644 --- 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 index f3f3237..0a89120 100644 --- 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 index 00d9349..cd601ac 100644 --- 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) diff --git a/src/content/docs/api/classes/Node.md b/src/content/docs/api/classes/Node.md index 909f25f..f3c3790 100644 --- a/src/content/docs/api/classes/Node.md +++ b/src/content/docs/api/classes/Node.md @@ -9,7 +9,7 @@ Represents a Lavalink node ## Extends -- `EventEmitter` +- [`TypedEventEmitter`](/api/namespaces/utils/classes/typedeventemitter/)\<[`NodeEvents`](/api/type-aliases/nodeevents/)\> ## Constructors @@ -34,11 +34,11 @@ new Node(manager: Shoukaku, options: NodeOption): Node #### Overrides -`EventEmitter.constructor` +`TypedEventEmitter.constructor` #### Defined in -[node/Node.ts:154](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Node.ts#L154) +[shoukaku/src/node/Node.ts:157](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Node.ts#L157) ## Properties @@ -54,7 +54,7 @@ Group in which this node is contained #### Defined in -[node/Node.ts:100](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Node.ts#L100) +[shoukaku/src/node/Node.ts:103](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Node.ts#L103) *** @@ -70,7 +70,7 @@ Information about lavalink node #### Defined in -[node/Node.ts:128](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Node.ts#L128) +[shoukaku/src/node/Node.ts:131](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Node.ts#L131) *** @@ -86,7 +86,7 @@ Shoukaku class #### Defined in -[node/Node.ts:88](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Node.ts#L88) +[shoukaku/src/node/Node.ts:91](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Node.ts#L91) *** @@ -102,7 +102,7 @@ Name of this node #### Defined in -[node/Node.ts:96](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Node.ts#L96) +[shoukaku/src/node/Node.ts:99](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Node.ts#L99) *** @@ -118,7 +118,7 @@ The number of reconnects to Lavalink #### Defined in -[node/Node.ts:116](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Node.ts#L116) +[shoukaku/src/node/Node.ts:119](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Node.ts#L119) *** @@ -134,7 +134,7 @@ Lavalink rest API #### Defined in -[node/Node.ts:92](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Node.ts#L92) +[shoukaku/src/node/Node.ts:95](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Node.ts#L95) *** @@ -150,7 +150,7 @@ SessionId of this Lavalink connection (not to be confused with Discord SessionId #### Defined in -[node/Node.ts:136](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Node.ts#L136) +[shoukaku/src/node/Node.ts:139](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Node.ts#L139) *** @@ -166,7 +166,7 @@ The state of this connection #### Defined in -[node/Node.ts:120](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Node.ts#L120) +[shoukaku/src/node/Node.ts:123](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Node.ts#L123) *** @@ -182,7 +182,7 @@ Statistics from Lavalink #### Defined in -[node/Node.ts:124](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Node.ts#L124) +[shoukaku/src/node/Node.ts:127](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Node.ts#L127) *** @@ -198,7 +198,7 @@ Websocket version this node will use #### Defined in -[node/Node.ts:104](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Node.ts#L104) +[shoukaku/src/node/Node.ts:107](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Node.ts#L107) *** @@ -214,7 +214,7 @@ Websocket instance #### Defined in -[node/Node.ts:132](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Node.ts#L132) +[shoukaku/src/node/Node.ts:135](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Node.ts#L135) ## Methods @@ -234,7 +234,7 @@ Connect to Lavalink #### Defined in -[node/Node.ts:204](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Node.ts#L204) +[shoukaku/src/node/Node.ts:207](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Node.ts#L207) *** @@ -261,7 +261,84 @@ Disconnect from lavalink #### Defined in -[node/Node.ts:234](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Node.ts#L234) +[shoukaku/src/node/Node.ts:237](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Node.ts#L237) + +*** + + + +### emit() + +```ts +emit(eventName: K, ...args: NodeEvents[Extract]): boolean +``` + +Synchronously calls each of the listeners registered for the event named `eventName`, in the order they were registered, passing the supplied arguments +to each. + +Returns `true` if the event had listeners, `false` otherwise. + +```js +import { EventEmitter } from 'node:events'; +const myEmitter = new EventEmitter(); + +// First listener +myEmitter.on('event', function firstListener() { + console.log('Helloooo! first listener'); +}); +// Second listener +myEmitter.on('event', function secondListener(arg1, arg2) { + console.log(`event with parameters ${arg1}, ${arg2} in second listener`); +}); +// Third listener +myEmitter.on('event', function thirdListener(...args) { + const parameters = args.join(', '); + console.log(`event with parameters ${parameters} in third listener`); +}); + +console.log(myEmitter.listeners('event')); + +myEmitter.emit('event', 1, 2, 3, 4, 5); + +// Prints: +// [ +// [Function: firstListener], +// [Function: secondListener], +// [Function: thirdListener] +// ] +// Helloooo! first listener +// event with parameters 1, 2 in second listener +// event with parameters 1, 2, 3, 4, 5 in third listener +``` + +#### Type Parameters + +| Type Parameter | +| ------ | +| `K` *extends* `symbol` \| keyof ShoukakuEvents | + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `eventName` | `K` | +| ...`args` | [`NodeEvents`](/api/type-aliases/nodeevents/)\[`Extract`\<`K`, `string`\>\] | + +#### Returns + +`boolean` + +#### Inherited from + +[`TypedEventEmitter`](/api/namespaces/utils/classes/typedeventemitter/).[`emit`](/api/namespaces/utils/classes/typedeventemitter/#emit) + +#### Since + +v0.1.26 + +#### Defined in + +[shoukaku/src/Utils.ts:21](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/Utils.ts#L21) *** @@ -270,7 +347,7 @@ Disconnect from lavalink ### error() ```ts -error(error: unknown): void +error(error: Error): void ``` To emit error events easily @@ -279,7 +356,7 @@ To emit error events easily | Parameter | Type | Description | | ------ | ------ | ------ | -| `error` | `unknown` | error message | +| `error` | `Error` | error message | #### Returns @@ -287,4 +364,175 @@ To emit error events easily #### Defined in -[node/Node.ts:325](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Node.ts#L325) +[shoukaku/src/node/Node.ts:331](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Node.ts#L331) + +*** + + + +### off() + +```ts +off(eventName: K, listener: (...args: NodeEvents[Extract]) => void): this +``` + +Alias for `emitter.removeListener()`. + +#### Type Parameters + +| Type Parameter | +| ------ | +| `K` *extends* `symbol` \| keyof ShoukakuEvents | + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `eventName` | `K` | +| `listener` | (...`args`: [`NodeEvents`](/api/type-aliases/nodeevents/)\[`Extract`\<`K`, `string`\>\]) => `void` | + +#### Returns + +`this` + +#### Inherited from + +[`TypedEventEmitter`](/api/namespaces/utils/classes/typedeventemitter/).[`off`](/api/namespaces/utils/classes/typedeventemitter/#off) + +#### Since + +v10.0.0 + +#### Defined in + +[shoukaku/src/Utils.ts:17](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/Utils.ts#L17) + +*** + + + +### on() + +```ts +on(eventName: K, listener: (...args: NodeEvents[Extract]) => void): this +``` + +Adds the `listener` function to the end of the listeners array for the event +named `eventName`. No checks are made to see if the `listener` has already +been added. Multiple calls passing the same combination of `eventName` and +`listener` will result in the `listener` being added, and called, multiple times. + +```js +server.on('connection', (stream) => { + console.log('someone connected!'); +}); +``` + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +By default, event listeners are invoked in the order they are added. The `emitter.prependListener()` method can be used as an alternative to add the +event listener to the beginning of the listeners array. + +```js +import { EventEmitter } from 'node:events'; +const myEE = new EventEmitter(); +myEE.on('foo', () => console.log('a')); +myEE.prependListener('foo', () => console.log('b')); +myEE.emit('foo'); +// Prints: +// b +// a +``` + +#### Type Parameters + +| Type Parameter | +| ------ | +| `K` *extends* `symbol` \| keyof ShoukakuEvents | + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `eventName` | `K` | The name of the event. | +| `listener` | (...`args`: [`NodeEvents`](/api/type-aliases/nodeevents/)\[`Extract`\<`K`, `string`\>\]) => `void` | The callback function | + +#### Returns + +`this` + +#### Inherited from + +[`TypedEventEmitter`](/api/namespaces/utils/classes/typedeventemitter/).[`on`](/api/namespaces/utils/classes/typedeventemitter/#on) + +#### Since + +v0.1.101 + +#### Defined in + +[shoukaku/src/Utils.ts:9](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/Utils.ts#L9) + +*** + + + +### once() + +```ts +once(eventName: K, listener: (...args: NodeEvents[Extract]) => void): this +``` + +Adds a **one-time** `listener` function for the event named `eventName`. The +next time `eventName` is triggered, this listener is removed and then invoked. + +```js +server.once('connection', (stream) => { + console.log('Ah, we have our first user!'); +}); +``` + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +By default, event listeners are invoked in the order they are added. The `emitter.prependOnceListener()` method can be used as an alternative to add the +event listener to the beginning of the listeners array. + +```js +import { EventEmitter } from 'node:events'; +const myEE = new EventEmitter(); +myEE.once('foo', () => console.log('a')); +myEE.prependOnceListener('foo', () => console.log('b')); +myEE.emit('foo'); +// Prints: +// b +// a +``` + +#### Type Parameters + +| Type Parameter | +| ------ | +| `K` *extends* `symbol` \| keyof ShoukakuEvents | + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `eventName` | `K` | The name of the event. | +| `listener` | (...`args`: [`NodeEvents`](/api/type-aliases/nodeevents/)\[`Extract`\<`K`, `string`\>\]) => `void` | The callback function | + +#### Returns + +`this` + +#### Inherited from + +[`TypedEventEmitter`](/api/namespaces/utils/classes/typedeventemitter/).[`once`](/api/namespaces/utils/classes/typedeventemitter/#once) + +#### Since + +v0.3.0 + +#### Defined in + +[shoukaku/src/Utils.ts:13](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/Utils.ts#L13) diff --git a/src/content/docs/api/classes/Player.md b/src/content/docs/api/classes/Player.md index f7efb1a..0204268 100644 --- a/src/content/docs/api/classes/Player.md +++ b/src/content/docs/api/classes/Player.md @@ -9,7 +9,7 @@ Wrapper object around Lavalink ## Extends -- `EventEmitter` +- [`TypedEventEmitter`](/api/namespaces/utils/classes/typedeventemitter/)\<[`PlayerEvents`](/api/type-aliases/playerevents/)\> ## Constructors @@ -32,9 +32,13 @@ new Player(guildId: string, node: Node): Player [`Player`](/api/classes/player/) +#### Overrides + +`TypedEventEmitter.constructor` + #### Defined in -[guild/Player.ts:212](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L212) +[shoukaku/src/guild/Player.ts:207](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L207) ## Properties @@ -50,7 +54,7 @@ Filters on current track #### Defined in -[guild/Player.ts:207](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L207) +[shoukaku/src/guild/Player.ts:202](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L202) *** @@ -66,7 +70,7 @@ GuildId of this player #### Defined in -[guild/Player.ts:179](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L179) +[shoukaku/src/guild/Player.ts:174](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L174) *** @@ -82,7 +86,7 @@ Lavalink node this player is connected to #### Defined in -[guild/Player.ts:183](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L183) +[shoukaku/src/guild/Player.ts:178](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L178) *** @@ -98,7 +102,7 @@ Pause status in current player #### Defined in -[guild/Player.ts:195](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L195) +[shoukaku/src/guild/Player.ts:190](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L190) *** @@ -114,7 +118,7 @@ Ping represents the number of milliseconds between heartbeat and ack. Could be ` #### Defined in -[guild/Player.ts:199](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L199) +[shoukaku/src/guild/Player.ts:194](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L194) *** @@ -130,7 +134,7 @@ Position in ms of current track #### Defined in -[guild/Player.ts:203](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L203) +[shoukaku/src/guild/Player.ts:198](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L198) *** @@ -146,7 +150,7 @@ Base64 encoded data of the current track #### Defined in -[guild/Player.ts:187](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L187) +[shoukaku/src/guild/Player.ts:182](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L182) *** @@ -162,7 +166,7 @@ Global volume of the player #### Defined in -[guild/Player.ts:191](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L191) +[shoukaku/src/guild/Player.ts:186](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L186) ## Accessors @@ -180,7 +184,7 @@ get data(): UpdatePlayerInfo #### Defined in -[guild/Player.ts:224](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L224) +[shoukaku/src/guild/Player.ts:219](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L219) ## Methods @@ -200,7 +204,7 @@ Clear all filters applied to the currently playing track #### Defined in -[guild/Player.ts:415](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L415) +[shoukaku/src/guild/Player.ts:410](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L410) *** @@ -220,7 +224,7 @@ Destroys the player in remote lavalink side #### Defined in -[guild/Player.ts:279](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L279) +[shoukaku/src/guild/Player.ts:274](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L274) *** @@ -229,23 +233,75 @@ Destroys the player in remote lavalink side ### emit() ```ts -emit(event: string | symbol, ...args: unknown[]): boolean +emit(eventName: K, ...args: PlayerEvents[Extract]): boolean +``` + +Synchronously calls each of the listeners registered for the event named `eventName`, in the order they were registered, passing the supplied arguments +to each. + +Returns `true` if the event had listeners, `false` otherwise. + +```js +import { EventEmitter } from 'node:events'; +const myEmitter = new EventEmitter(); + +// First listener +myEmitter.on('event', function firstListener() { + console.log('Helloooo! first listener'); +}); +// Second listener +myEmitter.on('event', function secondListener(arg1, arg2) { + console.log(`event with parameters ${arg1}, ${arg2} in second listener`); +}); +// Third listener +myEmitter.on('event', function thirdListener(...args) { + const parameters = args.join(', '); + console.log(`event with parameters ${parameters} in third listener`); +}); + +console.log(myEmitter.listeners('event')); + +myEmitter.emit('event', 1, 2, 3, 4, 5); + +// Prints: +// [ +// [Function: firstListener], +// [Function: secondListener], +// [Function: thirdListener] +// ] +// Helloooo! first listener +// event with parameters 1, 2 in second listener +// event with parameters 1, 2, 3, 4, 5 in third listener ``` +#### Type Parameters + +| Type Parameter | +| ------ | +| `K` *extends* `symbol` \| keyof PlayerEvents | + #### Parameters | Parameter | Type | | ------ | ------ | -| `event` | `string` \| `symbol` | -| ...`args` | `unknown`[] | +| `eventName` | `K` | +| ...`args` | [`PlayerEvents`](/api/type-aliases/playerevents/)\[`Extract`\<`K`, `string`\>\] | #### Returns `boolean` +#### Inherited from + +[`TypedEventEmitter`](/api/namespaces/utils/classes/typedeventemitter/).[`emit`](/api/namespaces/utils/classes/typedeventemitter/#emit) + +#### Since + +v0.1.26 + #### Defined in -[guild/Player.ts:168](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L168) +[shoukaku/src/Utils.ts:21](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/Utils.ts#L21) *** @@ -273,7 +329,7 @@ true if the player was moved, false if not #### Defined in -[guild/Player.ts:250](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L250) +[shoukaku/src/guild/Player.ts:245](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L245) *** @@ -282,29 +338,39 @@ true if the player was moved, false if not ### off() ```ts -off(event: K, listener: (...args: PlayerEvents[K]) => void): this +off(eventName: K, listener: (...args: PlayerEvents[Extract]) => void): this ``` +Alias for `emitter.removeListener()`. + #### Type Parameters | Type Parameter | | ------ | -| `K` *extends* keyof [`PlayerEvents`](/api/interfaces/playerevents/) | +| `K` *extends* `symbol` \| keyof PlayerEvents | #### Parameters | Parameter | Type | | ------ | ------ | -| `event` | `K` | -| `listener` | (...`args`: [`PlayerEvents`](/api/interfaces/playerevents/)\[`K`\]) => `void` | +| `eventName` | `K` | +| `listener` | (...`args`: [`PlayerEvents`](/api/type-aliases/playerevents/)\[`Extract`\<`K`, `string`\>\]) => `void` | #### Returns `this` +#### Inherited from + +[`TypedEventEmitter`](/api/namespaces/utils/classes/typedeventemitter/).[`off`](/api/namespaces/utils/classes/typedeventemitter/#off) + +#### Since + +v10.0.0 + #### Defined in -[guild/Player.ts:167](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L167) +[shoukaku/src/Utils.ts:17](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/Utils.ts#L17) *** @@ -313,29 +379,64 @@ off(event: K, listener: (...args: PlayerEvents[K]) => void): this ### on() ```ts -on(event: K, listener: (...args: PlayerEvents[K]) => void): this +on(eventName: K, listener: (...args: PlayerEvents[Extract]) => void): this +``` + +Adds the `listener` function to the end of the listeners array for the event +named `eventName`. No checks are made to see if the `listener` has already +been added. Multiple calls passing the same combination of `eventName` and +`listener` will result in the `listener` being added, and called, multiple times. + +```js +server.on('connection', (stream) => { + console.log('someone connected!'); +}); +``` + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +By default, event listeners are invoked in the order they are added. The `emitter.prependListener()` method can be used as an alternative to add the +event listener to the beginning of the listeners array. + +```js +import { EventEmitter } from 'node:events'; +const myEE = new EventEmitter(); +myEE.on('foo', () => console.log('a')); +myEE.prependListener('foo', () => console.log('b')); +myEE.emit('foo'); +// Prints: +// b +// a ``` #### Type Parameters | Type Parameter | | ------ | -| `K` *extends* keyof [`PlayerEvents`](/api/interfaces/playerevents/) | +| `K` *extends* `symbol` \| keyof PlayerEvents | #### Parameters -| Parameter | Type | -| ------ | ------ | -| `event` | `K` | -| `listener` | (...`args`: [`PlayerEvents`](/api/interfaces/playerevents/)\[`K`\]) => `void` | +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `eventName` | `K` | The name of the event. | +| `listener` | (...`args`: [`PlayerEvents`](/api/type-aliases/playerevents/)\[`Extract`\<`K`, `string`\>\]) => `void` | The callback function | #### Returns `this` +#### Inherited from + +[`TypedEventEmitter`](/api/namespaces/utils/classes/typedeventemitter/).[`on`](/api/namespaces/utils/classes/typedeventemitter/#on) + +#### Since + +v0.1.101 + #### Defined in -[guild/Player.ts:165](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L165) +[shoukaku/src/Utils.ts:9](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/Utils.ts#L9) *** @@ -361,7 +462,7 @@ Handle player update data #### Defined in -[guild/Player.ts:516](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L516) +[shoukaku/src/guild/Player.ts:511](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L511) *** @@ -370,29 +471,62 @@ Handle player update data ### once() ```ts -once(event: K, listener: (...args: PlayerEvents[K]) => void): this +once(eventName: K, listener: (...args: PlayerEvents[Extract]) => void): this +``` + +Adds a **one-time** `listener` function for the event named `eventName`. The +next time `eventName` is triggered, this listener is removed and then invoked. + +```js +server.once('connection', (stream) => { + console.log('Ah, we have our first user!'); +}); +``` + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +By default, event listeners are invoked in the order they are added. The `emitter.prependOnceListener()` method can be used as an alternative to add the +event listener to the beginning of the listeners array. + +```js +import { EventEmitter } from 'node:events'; +const myEE = new EventEmitter(); +myEE.once('foo', () => console.log('a')); +myEE.prependOnceListener('foo', () => console.log('b')); +myEE.emit('foo'); +// Prints: +// b +// a ``` #### Type Parameters | Type Parameter | | ------ | -| `K` *extends* keyof [`PlayerEvents`](/api/interfaces/playerevents/) | +| `K` *extends* `symbol` \| keyof PlayerEvents | #### Parameters -| Parameter | Type | -| ------ | ------ | -| `event` | `K` | -| `listener` | (...`args`: [`PlayerEvents`](/api/interfaces/playerevents/)\[`K`\]) => `void` | +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `eventName` | `K` | The name of the event. | +| `listener` | (...`args`: [`PlayerEvents`](/api/type-aliases/playerevents/)\[`Extract`\<`K`, `string`\>\]) => `void` | The callback function | #### Returns `this` +#### Inherited from + +[`TypedEventEmitter`](/api/namespaces/utils/classes/typedeventemitter/).[`once`](/api/namespaces/utils/classes/typedeventemitter/#once) + +#### Since + +v0.3.0 + #### Defined in -[guild/Player.ts:166](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L166) +[shoukaku/src/Utils.ts:13](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/Utils.ts#L13) *** @@ -419,7 +553,7 @@ Play a new track #### Defined in -[guild/Player.ts:288](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L288) +[shoukaku/src/guild/Player.ts:283](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L283) *** @@ -446,7 +580,7 @@ Resumes the current track #### Defined in -[guild/Player.ts:435](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L435) +[shoukaku/src/guild/Player.ts:430](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L430) *** @@ -472,7 +606,7 @@ Seek to a specific time in the currently playing track #### Defined in -[guild/Player.ts:311](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L311) +[shoukaku/src/guild/Player.ts:306](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L306) *** @@ -498,7 +632,7 @@ Change the channel mix settings applied to the currently playing track #### Defined in -[guild/Player.ts:392](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L392) +[shoukaku/src/guild/Player.ts:387](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L387) *** @@ -526,7 +660,7 @@ The current player instance #### Defined in -[guild/Player.ts:384](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L384) +[shoukaku/src/guild/Player.ts:379](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L379) *** @@ -552,7 +686,7 @@ Change the equalizer settings applied to the currently playing track #### Defined in -[guild/Player.ts:335](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L335) +[shoukaku/src/guild/Player.ts:330](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L330) *** @@ -578,7 +712,7 @@ Sets the filter volume of the player #### Defined in -[guild/Player.ts:327](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L327) +[shoukaku/src/guild/Player.ts:322](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L322) *** @@ -604,7 +738,7 @@ Change the all filter settings applied to the currently playing track #### Defined in -[guild/Player.ts:408](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L408) +[shoukaku/src/guild/Player.ts:403](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L403) *** @@ -630,7 +764,7 @@ Sets the global volume of the player #### Defined in -[guild/Player.ts:319](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L319) +[shoukaku/src/guild/Player.ts:314](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L314) *** @@ -656,7 +790,7 @@ Change the karaoke settings applied to the currently playing track #### Defined in -[guild/Player.ts:343](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L343) +[shoukaku/src/guild/Player.ts:338](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L338) *** @@ -682,7 +816,7 @@ Change the low pass settings applied to the currently playing track #### Defined in -[guild/Player.ts:400](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L400) +[shoukaku/src/guild/Player.ts:395](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L395) *** @@ -708,7 +842,7 @@ Pause or unpause the currently playing track #### Defined in -[guild/Player.ts:303](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L303) +[shoukaku/src/guild/Player.ts:298](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L298) *** @@ -734,7 +868,7 @@ Change the rotation settings applied to the currently playing track #### Defined in -[guild/Player.ts:375](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L375) +[shoukaku/src/guild/Player.ts:370](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L370) *** @@ -760,7 +894,7 @@ Change the timescale settings applied to the currently playing track #### Defined in -[guild/Player.ts:351](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L351) +[shoukaku/src/guild/Player.ts:346](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L346) *** @@ -786,7 +920,7 @@ Change the tremolo settings applied to the currently playing track #### Defined in -[guild/Player.ts:359](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L359) +[shoukaku/src/guild/Player.ts:354](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L354) *** @@ -812,7 +946,7 @@ Change the vibrato settings applied to the currently playing track #### Defined in -[guild/Player.ts:367](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L367) +[shoukaku/src/guild/Player.ts:362](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L362) *** @@ -832,7 +966,7 @@ Stop the currently playing track #### Defined in -[guild/Player.ts:295](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L295) +[shoukaku/src/guild/Player.ts:290](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L290) *** @@ -859,4 +993,4 @@ If you want to update the whole player yourself, sends raw update player info to #### Defined in -[guild/Player.ts:457](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L457) +[shoukaku/src/guild/Player.ts:452](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L452) diff --git a/src/content/docs/api/classes/Rest.md b/src/content/docs/api/classes/Rest.md index bf31c57..76b82bf 100644 --- a/src/content/docs/api/classes/Rest.md +++ b/src/content/docs/api/classes/Rest.md @@ -30,7 +30,7 @@ new Rest(node: Node, options: NodeOption): Rest #### Defined in -[node/Rest.ts:192](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Rest.ts#L192) +[shoukaku/src/node/Rest.ts:192](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Rest.ts#L192) ## Methods @@ -58,7 +58,7 @@ Promise that resolves to a track #### Defined in -[node/Rest.ts:221](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Rest.ts#L221) +[shoukaku/src/node/Rest.ts:221](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Rest.ts#L221) *** @@ -84,7 +84,7 @@ Deletes a Lavalink player #### Defined in -[node/Rest.ts:275](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Rest.ts#L275) +[shoukaku/src/node/Rest.ts:275](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Rest.ts#L275) *** @@ -100,11 +100,11 @@ Get Lavalink info #### Returns -`Promise`\<`undefined` \| [`NodeInfo`](/api/type-aliases/nodeinfo/)\> +`Promise`\<`undefined` \| [`NodeInfo`](/api/interfaces/nodeinfo/)\> #### Defined in -[node/Rest.ts:344](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Rest.ts#L344) +[shoukaku/src/node/Rest.ts:344](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Rest.ts#L344) *** @@ -132,7 +132,7 @@ Promise that resolves to a Lavalink player #### Defined in -[node/Rest.ts:245](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Rest.ts#L245) +[shoukaku/src/node/Rest.ts:245](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Rest.ts#L245) *** @@ -154,7 +154,7 @@ Promise that resolves to an array of Lavalink players #### Defined in -[node/Rest.ts:233](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Rest.ts#L233) +[shoukaku/src/node/Rest.ts:233](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Rest.ts#L233) *** @@ -176,7 +176,7 @@ Promise that resolves to a routeplanner response #### Defined in -[node/Rest.ts:317](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Rest.ts#L317) +[shoukaku/src/node/Rest.ts:317](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Rest.ts#L317) *** @@ -204,7 +204,7 @@ A promise that resolves to a Lavalink response #### Defined in -[node/Rest.ts:208](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Rest.ts#L208) +[shoukaku/src/node/Rest.ts:208](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Rest.ts#L208) *** @@ -226,7 +226,7 @@ Promise that resolves to a node stats response #### Defined in -[node/Rest.ts:305](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Rest.ts#L305) +[shoukaku/src/node/Rest.ts:305](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Rest.ts#L305) *** @@ -252,7 +252,7 @@ Release blacklisted IP address into pool of IPs #### Defined in -[node/Rest.ts:329](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Rest.ts#L329) +[shoukaku/src/node/Rest.ts:329](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Rest.ts#L329) *** @@ -280,7 +280,7 @@ Promise that resolves to a Lavalink player #### Defined in -[node/Rest.ts:258](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Rest.ts#L258) +[shoukaku/src/node/Rest.ts:258](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Rest.ts#L258) *** @@ -309,4 +309,4 @@ Promise that resolves to a Lavalink player #### Defined in -[node/Rest.ts:289](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Rest.ts#L289) +[shoukaku/src/node/Rest.ts:289](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Rest.ts#L289) diff --git a/src/content/docs/api/classes/RestError.md b/src/content/docs/api/classes/RestError.md new file mode 100644 index 0000000..a467be5 --- /dev/null +++ b/src/content/docs/api/classes/RestError.md @@ -0,0 +1,162 @@ +--- +editUrl: false +next: false +prev: false +title: "RestError" +--- + +## Extends + +- `Error` + +## Constructors + + + +### new RestError() + +```ts +new RestError(__namedParameters: LavalinkRestError): RestError +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `LavalinkRestError` | + +#### Returns + +[`RestError`](/api/classes/resterror/) + +#### Overrides + +`Error.constructor` + +#### Defined in + +[shoukaku/src/node/Rest.ts:427](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Rest.ts#L427) + +## Properties + + + +### error + +```ts +error: string; +``` + +#### Defined in + +[shoukaku/src/node/Rest.ts:423](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Rest.ts#L423) + +*** + + + +### message + +```ts +message: string; +``` + +#### Inherited from + +`Error.message` + +#### Defined in + +node\_modules/typescript/lib/lib.es5.d.ts:1077 + +*** + + + +### name + +```ts +name: string; +``` + +#### Inherited from + +`Error.name` + +#### Defined in + +node\_modules/typescript/lib/lib.es5.d.ts:1076 + +*** + + + +### path + +```ts +path: string; +``` + +#### Defined in + +[shoukaku/src/node/Rest.ts:425](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Rest.ts#L425) + +*** + + + +### stack? + +```ts +optional stack: string; +``` + +#### Inherited from + +`Error.stack` + +#### Defined in + +node\_modules/typescript/lib/lib.es5.d.ts:1078 + +*** + + + +### status + +```ts +status: number; +``` + +#### Defined in + +[shoukaku/src/node/Rest.ts:422](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Rest.ts#L422) + +*** + + + +### timestamp + +```ts +timestamp: number; +``` + +#### Defined in + +[shoukaku/src/node/Rest.ts:421](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Rest.ts#L421) + +*** + + + +### trace? + +```ts +optional trace: string; +``` + +#### Defined in + +[shoukaku/src/node/Rest.ts:424](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Rest.ts#L424) diff --git a/src/content/docs/api/classes/Shoukaku.md b/src/content/docs/api/classes/Shoukaku.md index 5b352e5..d8fcfd7 100644 --- a/src/content/docs/api/classes/Shoukaku.md +++ b/src/content/docs/api/classes/Shoukaku.md @@ -9,7 +9,7 @@ Main Shoukaku class ## Extends -- `EventEmitter` +- [`TypedEventEmitter`](/api/namespaces/utils/classes/typedeventemitter/)\<[`ShoukakuEvents`](/api/type-aliases/shoukakuevents/)\> ## Constructors @@ -36,9 +36,13 @@ new Shoukaku( [`Shoukaku`](/api/classes/shoukaku/) +#### Overrides + +`TypedEventEmitter.constructor` + #### Defined in -[Shoukaku.ts:187](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/Shoukaku.ts#L187) +[shoukaku/src/Shoukaku.ts:182](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/Shoukaku.ts#L182) ## Properties @@ -54,7 +58,7 @@ Voice connections being handled #### Defined in -[Shoukaku.ts:163](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/Shoukaku.ts#L163) +[shoukaku/src/Shoukaku.ts:158](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/Shoukaku.ts#L158) *** @@ -70,7 +74,7 @@ Discord library connector #### Defined in -[Shoukaku.ts:151](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/Shoukaku.ts#L151) +[shoukaku/src/Shoukaku.ts:146](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/Shoukaku.ts#L146) *** @@ -86,7 +90,7 @@ Shoukaku instance identifier #### Defined in -[Shoukaku.ts:171](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/Shoukaku.ts#L171) +[shoukaku/src/Shoukaku.ts:166](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/Shoukaku.ts#L166) *** @@ -102,7 +106,7 @@ Connected Lavalink nodes #### Defined in -[Shoukaku.ts:159](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/Shoukaku.ts#L159) +[shoukaku/src/Shoukaku.ts:154](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/Shoukaku.ts#L154) *** @@ -118,7 +122,7 @@ Shoukaku options #### Defined in -[Shoukaku.ts:155](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/Shoukaku.ts#L155) +[shoukaku/src/Shoukaku.ts:150](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/Shoukaku.ts#L150) *** @@ -134,7 +138,7 @@ Players being handled #### Defined in -[Shoukaku.ts:167](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/Shoukaku.ts#L167) +[shoukaku/src/Shoukaku.ts:162](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/Shoukaku.ts#L162) ## Methods @@ -160,7 +164,7 @@ Add a Lavalink node to the pool of available nodes #### Defined in -[Shoukaku.ts:215](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/Shoukaku.ts#L215) +[shoukaku/src/Shoukaku.ts:210](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/Shoukaku.ts#L210) *** @@ -169,23 +173,75 @@ Add a Lavalink node to the pool of available nodes ### emit() ```ts -emit(event: string | symbol, ...args: any[]): boolean +emit(eventName: K, ...args: ShoukakuEvents[Extract]): boolean +``` + +Synchronously calls each of the listeners registered for the event named `eventName`, in the order they were registered, passing the supplied arguments +to each. + +Returns `true` if the event had listeners, `false` otherwise. + +```js +import { EventEmitter } from 'node:events'; +const myEmitter = new EventEmitter(); + +// First listener +myEmitter.on('event', function firstListener() { + console.log('Helloooo! first listener'); +}); +// Second listener +myEmitter.on('event', function secondListener(arg1, arg2) { + console.log(`event with parameters ${arg1}, ${arg2} in second listener`); +}); +// Third listener +myEmitter.on('event', function thirdListener(...args) { + const parameters = args.join(', '); + console.log(`event with parameters ${parameters} in third listener`); +}); + +console.log(myEmitter.listeners('event')); + +myEmitter.emit('event', 1, 2, 3, 4, 5); + +// Prints: +// [ +// [Function: firstListener], +// [Function: secondListener], +// [Function: thirdListener] +// ] +// Helloooo! first listener +// event with parameters 1, 2 in second listener +// event with parameters 1, 2, 3, 4, 5 in third listener ``` +#### Type Parameters + +| Type Parameter | +| ------ | +| `K` *extends* `symbol` \| keyof ShoukakuEvents | + #### Parameters | Parameter | Type | | ------ | ------ | -| `event` | `string` \| `symbol` | -| ...`args` | `any`[] | +| `eventName` | `K` | +| ...`args` | [`ShoukakuEvents`](/api/type-aliases/shoukakuevents/)\[`Extract`\<`K`, `string`\>\] | #### Returns `boolean` +#### Inherited from + +[`TypedEventEmitter`](/api/namespaces/utils/classes/typedeventemitter/).[`emit`](/api/namespaces/utils/classes/typedeventemitter/#emit) + +#### Since + +v0.1.26 + #### Defined in -[Shoukaku.ts:141](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/Shoukaku.ts#L141) +[shoukaku/src/Utils.ts:21](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/Utils.ts#L21) *** @@ -213,7 +269,7 @@ An ideal node for you to do things with #### Defined in -[Shoukaku.ts:203](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/Shoukaku.ts#L203) +[shoukaku/src/Shoukaku.ts:198](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/Shoukaku.ts#L198) *** @@ -241,7 +297,7 @@ The created player #### Defined in -[Shoukaku.ts:248](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/Shoukaku.ts#L248) +[shoukaku/src/Shoukaku.ts:243](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/Shoukaku.ts#L243) *** @@ -269,7 +325,7 @@ The destroyed / disconnected player or undefined if none #### Defined in -[Shoukaku.ts:284](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/Shoukaku.ts#L284) +[shoukaku/src/Shoukaku.ts:279](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/Shoukaku.ts#L279) *** @@ -278,29 +334,39 @@ The destroyed / disconnected player or undefined if none ### off() ```ts -off(event: K, listener: (...args: ShoukakuEvents[K]) => void): this +off(eventName: K, listener: (...args: ShoukakuEvents[Extract]) => void): this ``` +Alias for `emitter.removeListener()`. + #### Type Parameters | Type Parameter | | ------ | -| `K` *extends* keyof [`ShoukakuEvents`](/api/interfaces/shoukakuevents/) | +| `K` *extends* `symbol` \| keyof ShoukakuEvents | #### Parameters | Parameter | Type | | ------ | ------ | -| `event` | `K` | -| `listener` | (...`args`: [`ShoukakuEvents`](/api/interfaces/shoukakuevents/)\[`K`\]) => `void` | +| `eventName` | `K` | +| `listener` | (...`args`: [`ShoukakuEvents`](/api/type-aliases/shoukakuevents/)\[`Extract`\<`K`, `string`\>\]) => `void` | #### Returns `this` +#### Inherited from + +[`TypedEventEmitter`](/api/namespaces/utils/classes/typedeventemitter/).[`off`](/api/namespaces/utils/classes/typedeventemitter/#off) + +#### Since + +v10.0.0 + #### Defined in -[Shoukaku.ts:140](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/Shoukaku.ts#L140) +[shoukaku/src/Utils.ts:17](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/Utils.ts#L17) *** @@ -309,29 +375,64 @@ off(event: K, listener: (...args: ShoukakuEvents[K]) => void): this ### on() ```ts -on(event: K, listener: (...args: ShoukakuEvents[K]) => void): this +on(eventName: K, listener: (...args: ShoukakuEvents[Extract]) => void): this +``` + +Adds the `listener` function to the end of the listeners array for the event +named `eventName`. No checks are made to see if the `listener` has already +been added. Multiple calls passing the same combination of `eventName` and +`listener` will result in the `listener` being added, and called, multiple times. + +```js +server.on('connection', (stream) => { + console.log('someone connected!'); +}); +``` + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +By default, event listeners are invoked in the order they are added. The `emitter.prependListener()` method can be used as an alternative to add the +event listener to the beginning of the listeners array. + +```js +import { EventEmitter } from 'node:events'; +const myEE = new EventEmitter(); +myEE.on('foo', () => console.log('a')); +myEE.prependListener('foo', () => console.log('b')); +myEE.emit('foo'); +// Prints: +// b +// a ``` #### Type Parameters | Type Parameter | | ------ | -| `K` *extends* keyof [`ShoukakuEvents`](/api/interfaces/shoukakuevents/) | +| `K` *extends* `symbol` \| keyof ShoukakuEvents | #### Parameters -| Parameter | Type | -| ------ | ------ | -| `event` | `K` | -| `listener` | (...`args`: [`ShoukakuEvents`](/api/interfaces/shoukakuevents/)\[`K`\]) => `void` | +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `eventName` | `K` | The name of the event. | +| `listener` | (...`args`: [`ShoukakuEvents`](/api/type-aliases/shoukakuevents/)\[`Extract`\<`K`, `string`\>\]) => `void` | The callback function | #### Returns `this` +#### Inherited from + +[`TypedEventEmitter`](/api/namespaces/utils/classes/typedeventemitter/).[`on`](/api/namespaces/utils/classes/typedeventemitter/#on) + +#### Since + +v0.1.101 + #### Defined in -[Shoukaku.ts:138](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/Shoukaku.ts#L138) +[shoukaku/src/Utils.ts:9](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/Utils.ts#L9) *** @@ -340,29 +441,62 @@ on(event: K, listener: (...args: ShoukakuEvents[K]) => void): this ### once() ```ts -once(event: K, listener: (...args: ShoukakuEvents[K]) => void): this +once(eventName: K, listener: (...args: ShoukakuEvents[Extract]) => void): this +``` + +Adds a **one-time** `listener` function for the event named `eventName`. The +next time `eventName` is triggered, this listener is removed and then invoked. + +```js +server.once('connection', (stream) => { + console.log('Ah, we have our first user!'); +}); +``` + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +By default, event listeners are invoked in the order they are added. The `emitter.prependOnceListener()` method can be used as an alternative to add the +event listener to the beginning of the listeners array. + +```js +import { EventEmitter } from 'node:events'; +const myEE = new EventEmitter(); +myEE.once('foo', () => console.log('a')); +myEE.prependOnceListener('foo', () => console.log('b')); +myEE.emit('foo'); +// Prints: +// b +// a ``` #### Type Parameters | Type Parameter | | ------ | -| `K` *extends* keyof [`ShoukakuEvents`](/api/interfaces/shoukakuevents/) | +| `K` *extends* `symbol` \| keyof ShoukakuEvents | #### Parameters -| Parameter | Type | -| ------ | ------ | -| `event` | `K` | -| `listener` | (...`args`: [`ShoukakuEvents`](/api/interfaces/shoukakuevents/)\[`K`\]) => `void` | +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `eventName` | `K` | The name of the event. | +| `listener` | (...`args`: [`ShoukakuEvents`](/api/type-aliases/shoukakuevents/)\[`Extract`\<`K`, `string`\>\]) => `void` | The callback function | #### Returns `this` +#### Inherited from + +[`TypedEventEmitter`](/api/namespaces/utils/classes/typedeventemitter/).[`once`](/api/namespaces/utils/classes/typedeventemitter/#once) + +#### Since + +v0.3.0 + #### Defined in -[Shoukaku.ts:139](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/Shoukaku.ts#L139) +[shoukaku/src/Utils.ts:13](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/Utils.ts#L13) *** @@ -389,4 +523,4 @@ Remove a Lavalink node from the pool of available nodes #### Defined in -[Shoukaku.ts:233](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/Shoukaku.ts#L233) +[shoukaku/src/Shoukaku.ts:228](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/Shoukaku.ts#L228) diff --git a/src/content/docs/api/enumerations/LoadType.md b/src/content/docs/api/enumerations/LoadType.md index 7ba9ec3..1ed0718 100644 --- a/src/content/docs/api/enumerations/LoadType.md +++ b/src/content/docs/api/enumerations/LoadType.md @@ -9,8 +9,8 @@ title: "LoadType" | Enumeration Member | Value | Defined in | | ------ | ------ | ------ | -| `EMPTY` | `"empty"` | [node/Rest.ts:12](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Rest.ts#L12) | -| `ERROR` | `"error"` | [node/Rest.ts:13](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Rest.ts#L13) | -| `PLAYLIST` | `"playlist"` | [node/Rest.ts:10](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Rest.ts#L10) | -| `SEARCH` | `"search"` | [node/Rest.ts:11](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Rest.ts#L11) | -| `TRACK` | `"track"` | [node/Rest.ts:9](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Rest.ts#L9) | +| `EMPTY` | `"empty"` | [shoukaku/src/node/Rest.ts:12](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Rest.ts#L12) | +| `ERROR` | `"error"` | [shoukaku/src/node/Rest.ts:13](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Rest.ts#L13) | +| `PLAYLIST` | `"playlist"` | [shoukaku/src/node/Rest.ts:10](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Rest.ts#L10) | +| `SEARCH` | `"search"` | [shoukaku/src/node/Rest.ts:11](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Rest.ts#L11) | +| `TRACK` | `"track"` | [shoukaku/src/node/Rest.ts:9](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Rest.ts#L9) | diff --git a/src/content/docs/api/enumerations/PlayerEventType.md b/src/content/docs/api/enumerations/PlayerEventType.md index 62d93e0..3261d2a 100644 --- a/src/content/docs/api/enumerations/PlayerEventType.md +++ b/src/content/docs/api/enumerations/PlayerEventType.md @@ -9,8 +9,8 @@ title: "PlayerEventType" | Enumeration Member | Value | Defined in | | ------ | ------ | ------ | -| `TRACK_END_EVENT` | `"TrackEndEvent"` | [guild/Player.ts:13](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L13) | -| `TRACK_EXCEPTION_EVENT` | `"TrackExceptionEvent"` | [guild/Player.ts:14](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L14) | -| `TRACK_START_EVENT` | `"TrackStartEvent"` | [guild/Player.ts:12](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L12) | -| `TRACK_STUCK_EVENT` | `"TrackStuckEvent"` | [guild/Player.ts:15](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L15) | -| `WEBSOCKET_CLOSED_EVENT` | `"WebSocketClosedEvent"` | [guild/Player.ts:16](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L16) | +| `TRACK_END_EVENT` | `"TrackEndEvent"` | [shoukaku/src/guild/Player.ts:13](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L13) | +| `TRACK_EXCEPTION_EVENT` | `"TrackExceptionEvent"` | [shoukaku/src/guild/Player.ts:14](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L14) | +| `TRACK_START_EVENT` | `"TrackStartEvent"` | [shoukaku/src/guild/Player.ts:12](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L12) | +| `TRACK_STUCK_EVENT` | `"TrackStuckEvent"` | [shoukaku/src/guild/Player.ts:15](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L15) | +| `WEBSOCKET_CLOSED_EVENT` | `"WebSocketClosedEvent"` | [shoukaku/src/guild/Player.ts:16](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L16) | diff --git a/src/content/docs/api/interfaces/Address.md b/src/content/docs/api/interfaces/Address.md index 1e8d6e5..51d2b68 100644 --- a/src/content/docs/api/interfaces/Address.md +++ b/src/content/docs/api/interfaces/Address.md @@ -17,7 +17,7 @@ address: string; #### Defined in -[node/Rest.ts:78](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Rest.ts#L78) +[shoukaku/src/node/Rest.ts:78](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Rest.ts#L78) *** @@ -31,7 +31,7 @@ failingTime: string; #### Defined in -[node/Rest.ts:80](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Rest.ts#L80) +[shoukaku/src/node/Rest.ts:80](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Rest.ts#L80) *** @@ -45,4 +45,4 @@ failingTimestamp: number; #### Defined in -[node/Rest.ts:79](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Rest.ts#L79) +[shoukaku/src/node/Rest.ts:79](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Rest.ts#L79) diff --git a/src/content/docs/api/interfaces/Band.md b/src/content/docs/api/interfaces/Band.md index ae411f1..1aed6aa 100644 --- a/src/content/docs/api/interfaces/Band.md +++ b/src/content/docs/api/interfaces/Band.md @@ -17,7 +17,7 @@ band: number; #### Defined in -[guild/Player.ts:20](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L20) +[shoukaku/src/guild/Player.ts:20](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L20) *** @@ -31,4 +31,4 @@ gain: number; #### Defined in -[guild/Player.ts:21](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L21) +[shoukaku/src/guild/Player.ts:21](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L21) diff --git a/src/content/docs/api/interfaces/ChannelMixSettings.md b/src/content/docs/api/interfaces/ChannelMixSettings.md index 0c8811c..8e602c0 100644 --- a/src/content/docs/api/interfaces/ChannelMixSettings.md +++ b/src/content/docs/api/interfaces/ChannelMixSettings.md @@ -17,7 +17,7 @@ optional leftToLeft: number; #### Defined in -[guild/Player.ts:58](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L58) +[shoukaku/src/guild/Player.ts:58](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L58) *** @@ -31,7 +31,7 @@ optional leftToRight: number; #### Defined in -[guild/Player.ts:59](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L59) +[shoukaku/src/guild/Player.ts:59](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L59) *** @@ -45,7 +45,7 @@ optional rightToLeft: number; #### Defined in -[guild/Player.ts:60](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L60) +[shoukaku/src/guild/Player.ts:60](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L60) *** @@ -59,4 +59,4 @@ optional rightToRight: number; #### Defined in -[guild/Player.ts:61](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L61) +[shoukaku/src/guild/Player.ts:61](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L61) diff --git a/src/content/docs/api/interfaces/ConnectorMethods.md b/src/content/docs/api/interfaces/ConnectorMethods.md index 610447b..2016c9e 100644 --- a/src/content/docs/api/interfaces/ConnectorMethods.md +++ b/src/content/docs/api/interfaces/ConnectorMethods.md @@ -17,7 +17,7 @@ getId: any; #### Defined in -[connectors/Connector.ts:7](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/connectors/Connector.ts#L7) +[shoukaku/src/connectors/Connector.ts:9](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/connectors/Connector.ts#L9) *** @@ -31,4 +31,4 @@ sendPacket: any; #### Defined in -[connectors/Connector.ts:6](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/connectors/Connector.ts#L6) +[shoukaku/src/connectors/Connector.ts:8](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/connectors/Connector.ts#L8) diff --git a/src/content/docs/api/interfaces/DistortionSettings.md b/src/content/docs/api/interfaces/DistortionSettings.md index f95dba4..f0f2bf8 100644 --- a/src/content/docs/api/interfaces/DistortionSettings.md +++ b/src/content/docs/api/interfaces/DistortionSettings.md @@ -17,7 +17,7 @@ optional cosOffset: number; #### Defined in -[guild/Player.ts:49](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L49) +[shoukaku/src/guild/Player.ts:49](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L49) *** @@ -31,7 +31,7 @@ optional cosScale: number; #### Defined in -[guild/Player.ts:50](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L50) +[shoukaku/src/guild/Player.ts:50](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L50) *** @@ -45,7 +45,7 @@ optional offset: number; #### Defined in -[guild/Player.ts:53](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L53) +[shoukaku/src/guild/Player.ts:53](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L53) *** @@ -59,7 +59,7 @@ optional scale: number; #### Defined in -[guild/Player.ts:54](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L54) +[shoukaku/src/guild/Player.ts:54](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L54) *** @@ -73,7 +73,7 @@ optional sinOffset: number; #### Defined in -[guild/Player.ts:47](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L47) +[shoukaku/src/guild/Player.ts:47](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L47) *** @@ -87,7 +87,7 @@ optional sinScale: number; #### Defined in -[guild/Player.ts:48](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L48) +[shoukaku/src/guild/Player.ts:48](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L48) *** @@ -101,7 +101,7 @@ optional tanOffset: number; #### Defined in -[guild/Player.ts:51](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L51) +[shoukaku/src/guild/Player.ts:51](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L51) *** @@ -115,4 +115,4 @@ optional tanScale: number; #### Defined in -[guild/Player.ts:52](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L52) +[shoukaku/src/guild/Player.ts:52](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L52) diff --git a/src/content/docs/api/interfaces/EmptyResult.md b/src/content/docs/api/interfaces/EmptyResult.md index 0243f74..b6e717c 100644 --- a/src/content/docs/api/interfaces/EmptyResult.md +++ b/src/content/docs/api/interfaces/EmptyResult.md @@ -12,12 +12,12 @@ title: "EmptyResult" ### data ```ts -data: {}; +data: Record; ``` #### Defined in -[node/Rest.ts:67](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Rest.ts#L67) +[shoukaku/src/node/Rest.ts:67](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Rest.ts#L67) *** @@ -31,4 +31,4 @@ loadType: EMPTY; #### Defined in -[node/Rest.ts:66](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Rest.ts#L66) +[shoukaku/src/node/Rest.ts:66](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Rest.ts#L66) diff --git a/src/content/docs/api/interfaces/ErrorResult.md b/src/content/docs/api/interfaces/ErrorResult.md index f031009..662aaed 100644 --- a/src/content/docs/api/interfaces/ErrorResult.md +++ b/src/content/docs/api/interfaces/ErrorResult.md @@ -17,7 +17,7 @@ data: Exception; #### Defined in -[node/Rest.ts:72](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Rest.ts#L72) +[shoukaku/src/node/Rest.ts:72](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Rest.ts#L72) *** @@ -31,4 +31,4 @@ loadType: ERROR; #### Defined in -[node/Rest.ts:71](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Rest.ts#L71) +[shoukaku/src/node/Rest.ts:71](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Rest.ts#L71) diff --git a/src/content/docs/api/interfaces/Exception.md b/src/content/docs/api/interfaces/Exception.md index 0dc1151..f1bd30a 100644 --- a/src/content/docs/api/interfaces/Exception.md +++ b/src/content/docs/api/interfaces/Exception.md @@ -17,7 +17,7 @@ cause: string; #### Defined in -[node/Rest.ts:47](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Rest.ts#L47) +[shoukaku/src/node/Rest.ts:47](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Rest.ts#L47) *** @@ -31,7 +31,7 @@ message: string; #### Defined in -[node/Rest.ts:45](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Rest.ts#L45) +[shoukaku/src/node/Rest.ts:45](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Rest.ts#L45) *** @@ -45,4 +45,4 @@ severity: Severity; #### Defined in -[node/Rest.ts:46](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Rest.ts#L46) +[shoukaku/src/node/Rest.ts:46](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Rest.ts#L46) diff --git a/src/content/docs/api/interfaces/FilterOptions.md b/src/content/docs/api/interfaces/FilterOptions.md index 4c1e11f..a848529 100644 --- a/src/content/docs/api/interfaces/FilterOptions.md +++ b/src/content/docs/api/interfaces/FilterOptions.md @@ -17,7 +17,7 @@ optional channelMix: null | ChannelMixSettings; #### Defined in -[guild/Player.ts:122](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L122) +[shoukaku/src/guild/Player.ts:122](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L122) *** @@ -31,7 +31,7 @@ optional distortion: null | DistortionSettings; #### Defined in -[guild/Player.ts:121](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L121) +[shoukaku/src/guild/Player.ts:121](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L121) *** @@ -45,7 +45,7 @@ optional equalizer: Band[]; #### Defined in -[guild/Player.ts:115](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L115) +[shoukaku/src/guild/Player.ts:115](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L115) *** @@ -59,7 +59,7 @@ optional karaoke: null | KaraokeSettings; #### Defined in -[guild/Player.ts:116](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L116) +[shoukaku/src/guild/Player.ts:116](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L116) *** @@ -73,7 +73,7 @@ optional lowPass: null | LowPassSettings; #### Defined in -[guild/Player.ts:123](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L123) +[shoukaku/src/guild/Player.ts:123](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L123) *** @@ -87,7 +87,7 @@ optional rotation: null | RotationSettings; #### Defined in -[guild/Player.ts:120](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L120) +[shoukaku/src/guild/Player.ts:120](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L120) *** @@ -101,7 +101,7 @@ optional timescale: null | TimescaleSettings; #### Defined in -[guild/Player.ts:117](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L117) +[shoukaku/src/guild/Player.ts:117](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L117) *** @@ -115,7 +115,7 @@ optional tremolo: null | FreqSettings; #### Defined in -[guild/Player.ts:118](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L118) +[shoukaku/src/guild/Player.ts:118](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L118) *** @@ -129,7 +129,7 @@ optional vibrato: null | FreqSettings; #### Defined in -[guild/Player.ts:119](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L119) +[shoukaku/src/guild/Player.ts:119](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L119) *** @@ -143,4 +143,4 @@ optional volume: number; #### Defined in -[guild/Player.ts:114](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L114) +[shoukaku/src/guild/Player.ts:114](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L114) diff --git a/src/content/docs/api/interfaces/FreqSettings.md b/src/content/docs/api/interfaces/FreqSettings.md index efd7457..51581c3 100644 --- a/src/content/docs/api/interfaces/FreqSettings.md +++ b/src/content/docs/api/interfaces/FreqSettings.md @@ -17,7 +17,7 @@ optional depth: number; #### Defined in -[guild/Player.ts:39](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L39) +[shoukaku/src/guild/Player.ts:39](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L39) *** @@ -31,4 +31,4 @@ optional frequency: number; #### Defined in -[guild/Player.ts:38](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L38) +[shoukaku/src/guild/Player.ts:38](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L38) diff --git a/src/content/docs/api/interfaces/KaraokeSettings.md b/src/content/docs/api/interfaces/KaraokeSettings.md index 5e628a5..c2f159c 100644 --- a/src/content/docs/api/interfaces/KaraokeSettings.md +++ b/src/content/docs/api/interfaces/KaraokeSettings.md @@ -17,7 +17,7 @@ optional filterBand: number; #### Defined in -[guild/Player.ts:27](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L27) +[shoukaku/src/guild/Player.ts:27](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L27) *** @@ -31,7 +31,7 @@ optional filterWidth: number; #### Defined in -[guild/Player.ts:28](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L28) +[shoukaku/src/guild/Player.ts:28](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L28) *** @@ -45,7 +45,7 @@ optional level: number; #### Defined in -[guild/Player.ts:25](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L25) +[shoukaku/src/guild/Player.ts:25](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L25) *** @@ -59,4 +59,4 @@ optional monoLevel: number; #### Defined in -[guild/Player.ts:26](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L26) +[shoukaku/src/guild/Player.ts:26](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L26) diff --git a/src/content/docs/api/interfaces/LavalinkPlayer.md b/src/content/docs/api/interfaces/LavalinkPlayer.md index 1a36895..ac49c6a 100644 --- a/src/content/docs/api/interfaces/LavalinkPlayer.md +++ b/src/content/docs/api/interfaces/LavalinkPlayer.md @@ -17,7 +17,7 @@ filters: FilterOptions; #### Defined in -[node/Rest.ts:115](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Rest.ts#L115) +[shoukaku/src/node/Rest.ts:115](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Rest.ts#L115) *** @@ -31,7 +31,7 @@ guildId: string; #### Defined in -[node/Rest.ts:110](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Rest.ts#L110) +[shoukaku/src/node/Rest.ts:110](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Rest.ts#L110) *** @@ -45,7 +45,7 @@ paused: boolean; #### Defined in -[node/Rest.ts:113](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Rest.ts#L113) +[shoukaku/src/node/Rest.ts:113](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Rest.ts#L113) *** @@ -59,7 +59,7 @@ optional track: Track; #### Defined in -[node/Rest.ts:111](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Rest.ts#L111) +[shoukaku/src/node/Rest.ts:111](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Rest.ts#L111) *** @@ -73,7 +73,7 @@ voice: LavalinkPlayerVoice; #### Defined in -[node/Rest.ts:114](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Rest.ts#L114) +[shoukaku/src/node/Rest.ts:114](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Rest.ts#L114) *** @@ -87,4 +87,4 @@ volume: number; #### Defined in -[node/Rest.ts:112](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Rest.ts#L112) +[shoukaku/src/node/Rest.ts:112](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Rest.ts#L112) diff --git a/src/content/docs/api/interfaces/LavalinkPlayerVoice.md b/src/content/docs/api/interfaces/LavalinkPlayerVoice.md index 40ed1ff..6cc92bf 100644 --- a/src/content/docs/api/interfaces/LavalinkPlayerVoice.md +++ b/src/content/docs/api/interfaces/LavalinkPlayerVoice.md @@ -17,7 +17,7 @@ optional connected: boolean; #### Defined in -[node/Rest.ts:103](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Rest.ts#L103) +[shoukaku/src/node/Rest.ts:103](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Rest.ts#L103) *** @@ -31,7 +31,7 @@ endpoint: string; #### Defined in -[node/Rest.ts:101](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Rest.ts#L101) +[shoukaku/src/node/Rest.ts:101](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Rest.ts#L101) *** @@ -45,7 +45,7 @@ optional ping: number; #### Defined in -[node/Rest.ts:104](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Rest.ts#L104) +[shoukaku/src/node/Rest.ts:104](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Rest.ts#L104) *** @@ -59,7 +59,7 @@ sessionId: string; #### Defined in -[node/Rest.ts:102](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Rest.ts#L102) +[shoukaku/src/node/Rest.ts:102](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Rest.ts#L102) *** @@ -73,4 +73,4 @@ token: string; #### Defined in -[node/Rest.ts:100](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Rest.ts#L100) +[shoukaku/src/node/Rest.ts:100](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Rest.ts#L100) diff --git a/src/content/docs/api/interfaces/LavalinkPlayerVoiceOptions.md b/src/content/docs/api/interfaces/LavalinkPlayerVoiceOptions.md deleted file mode 100644 index 234c6b6..0000000 --- a/src/content/docs/api/interfaces/LavalinkPlayerVoiceOptions.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -editUrl: false -next: false -prev: false -title: "LavalinkPlayerVoiceOptions" ---- - -## Extends - -- `Omit`\<[`LavalinkPlayerVoice`](/api/interfaces/lavalinkplayervoice/), `"connected"` \| `"ping"`\> - -## Properties - - - -### endpoint - -```ts -endpoint: string; -``` - -#### Inherited from - -`Omit.endpoint` - -#### Defined in - -[node/Rest.ts:101](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Rest.ts#L101) - -*** - - - -### sessionId - -```ts -sessionId: string; -``` - -#### Inherited from - -`Omit.sessionId` - -#### Defined in - -[node/Rest.ts:102](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Rest.ts#L102) - -*** - - - -### token - -```ts -token: string; -``` - -#### Inherited from - -`Omit.token` - -#### Defined in - -[node/Rest.ts:100](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Rest.ts#L100) diff --git a/src/content/docs/api/interfaces/LowPassSettings.md b/src/content/docs/api/interfaces/LowPassSettings.md index a3157d1..d780b24 100644 --- a/src/content/docs/api/interfaces/LowPassSettings.md +++ b/src/content/docs/api/interfaces/LowPassSettings.md @@ -17,4 +17,4 @@ optional smoothing: number; #### Defined in -[guild/Player.ts:65](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L65) +[shoukaku/src/guild/Player.ts:65](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L65) diff --git a/src/content/docs/api/interfaces/NodeInfo.md b/src/content/docs/api/interfaces/NodeInfo.md new file mode 100644 index 0000000..b182088 --- /dev/null +++ b/src/content/docs/api/interfaces/NodeInfo.md @@ -0,0 +1,118 @@ +--- +editUrl: false +next: false +prev: false +title: "NodeInfo" +--- + +## Properties + + + +### buildTime + +```ts +buildTime: number; +``` + +#### Defined in + +[shoukaku/src/node/Node.ts:60](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Node.ts#L60) + +*** + + + +### filters + +```ts +filters: string[]; +``` + +#### Defined in + +[shoukaku/src/node/Node.ts:65](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Node.ts#L65) + +*** + + + +### git + +```ts +git: NodeInfoGit; +``` + +#### Defined in + +[shoukaku/src/node/Node.ts:61](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Node.ts#L61) + +*** + + + +### jvm + +```ts +jvm: string; +``` + +#### Defined in + +[shoukaku/src/node/Node.ts:62](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Node.ts#L62) + +*** + + + +### lavaplayer + +```ts +lavaplayer: string; +``` + +#### Defined in + +[shoukaku/src/node/Node.ts:63](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Node.ts#L63) + +*** + + + +### plugins + +```ts +plugins: NodeInfoPlugin[]; +``` + +#### Defined in + +[shoukaku/src/node/Node.ts:66](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Node.ts#L66) + +*** + + + +### sourceManagers + +```ts +sourceManagers: string[]; +``` + +#### Defined in + +[shoukaku/src/node/Node.ts:64](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Node.ts#L64) + +*** + + + +### version + +```ts +version: NodeInfoVersion; +``` + +#### Defined in + +[shoukaku/src/node/Node.ts:59](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Node.ts#L59) diff --git a/src/content/docs/api/interfaces/NodeInfoGit.md b/src/content/docs/api/interfaces/NodeInfoGit.md new file mode 100644 index 0000000..585a694 --- /dev/null +++ b/src/content/docs/api/interfaces/NodeInfoGit.md @@ -0,0 +1,48 @@ +--- +editUrl: false +next: false +prev: false +title: "NodeInfoGit" +--- + +## Properties + + + +### branch + +```ts +branch: string; +``` + +#### Defined in + +[shoukaku/src/node/Node.ts:48](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Node.ts#L48) + +*** + + + +### commit + +```ts +commit: string; +``` + +#### Defined in + +[shoukaku/src/node/Node.ts:49](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Node.ts#L49) + +*** + + + +### commitTime + +```ts +commitTime: number; +``` + +#### Defined in + +[shoukaku/src/node/Node.ts:50](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Node.ts#L50) diff --git a/src/content/docs/api/interfaces/NodeInfoPlugin.md b/src/content/docs/api/interfaces/NodeInfoPlugin.md new file mode 100644 index 0000000..ee6219e --- /dev/null +++ b/src/content/docs/api/interfaces/NodeInfoPlugin.md @@ -0,0 +1,34 @@ +--- +editUrl: false +next: false +prev: false +title: "NodeInfoPlugin" +--- + +## Properties + + + +### name + +```ts +name: string; +``` + +#### Defined in + +[shoukaku/src/node/Node.ts:54](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Node.ts#L54) + +*** + + + +### version + +```ts +version: string; +``` + +#### Defined in + +[shoukaku/src/node/Node.ts:55](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Node.ts#L55) diff --git a/src/content/docs/api/interfaces/NodeInfoVersion.md b/src/content/docs/api/interfaces/NodeInfoVersion.md new file mode 100644 index 0000000..d82fcff --- /dev/null +++ b/src/content/docs/api/interfaces/NodeInfoVersion.md @@ -0,0 +1,90 @@ +--- +editUrl: false +next: false +prev: false +title: "NodeInfoVersion" +--- + +## Properties + + + +### build? + +```ts +optional build: string; +``` + +#### Defined in + +[shoukaku/src/node/Node.ts:44](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Node.ts#L44) + +*** + + + +### major + +```ts +major: number; +``` + +#### Defined in + +[shoukaku/src/node/Node.ts:40](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Node.ts#L40) + +*** + + + +### minor + +```ts +minor: number; +``` + +#### Defined in + +[shoukaku/src/node/Node.ts:41](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Node.ts#L41) + +*** + + + +### patch + +```ts +patch: number; +``` + +#### Defined in + +[shoukaku/src/node/Node.ts:42](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Node.ts#L42) + +*** + + + +### preRelease? + +```ts +optional preRelease: string; +``` + +#### Defined in + +[shoukaku/src/node/Node.ts:43](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Node.ts#L43) + +*** + + + +### semver + +```ts +semver: string; +``` + +#### Defined in + +[shoukaku/src/node/Node.ts:39](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Node.ts#L39) diff --git a/src/content/docs/api/interfaces/NodeOption.md b/src/content/docs/api/interfaces/NodeOption.md index 8b69c76..c25ddfc 100644 --- a/src/content/docs/api/interfaces/NodeOption.md +++ b/src/content/docs/api/interfaces/NodeOption.md @@ -19,7 +19,7 @@ Credentials to access Lavalink #### Defined in -[Shoukaku.ts:33](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/Shoukaku.ts#L33) +[shoukaku/src/Shoukaku.ts:32](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/Shoukaku.ts#L32) *** @@ -35,7 +35,7 @@ Name of the Lavalink node group #### Defined in -[Shoukaku.ts:41](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/Shoukaku.ts#L41) +[shoukaku/src/Shoukaku.ts:40](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/Shoukaku.ts#L40) *** @@ -51,7 +51,7 @@ Name of the Lavalink node #### Defined in -[Shoukaku.ts:25](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/Shoukaku.ts#L25) +[shoukaku/src/Shoukaku.ts:24](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/Shoukaku.ts#L24) *** @@ -67,7 +67,7 @@ Whether to use secure protocols or not #### Defined in -[Shoukaku.ts:37](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/Shoukaku.ts#L37) +[shoukaku/src/Shoukaku.ts:36](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/Shoukaku.ts#L36) *** @@ -83,4 +83,4 @@ Lavalink node host and port without any prefix #### Defined in -[Shoukaku.ts:29](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/Shoukaku.ts#L29) +[shoukaku/src/Shoukaku.ts:28](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/Shoukaku.ts#L28) diff --git a/src/content/docs/api/interfaces/NonResumableHeaders.md b/src/content/docs/api/interfaces/NonResumableHeaders.md deleted file mode 100644 index 38b12c3..0000000 --- a/src/content/docs/api/interfaces/NonResumableHeaders.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -editUrl: false -next: false -prev: false -title: "NonResumableHeaders" ---- - -## Extends - -- `Omit`\<[`ResumableHeaders`](/api/interfaces/resumableheaders/), `"Session-Id"`\> diff --git a/src/content/docs/api/interfaces/PlayerEvent.md b/src/content/docs/api/interfaces/PlayerEvent.md index a67886a..283addb 100644 --- a/src/content/docs/api/interfaces/PlayerEvent.md +++ b/src/content/docs/api/interfaces/PlayerEvent.md @@ -25,7 +25,7 @@ guildId: string; #### Defined in -[guild/Player.ts:70](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L70) +[shoukaku/src/guild/Player.ts:70](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L70) *** @@ -39,4 +39,4 @@ op: EVENT; #### Defined in -[guild/Player.ts:69](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L69) +[shoukaku/src/guild/Player.ts:69](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L69) diff --git a/src/content/docs/api/interfaces/PlayerEvents.md b/src/content/docs/api/interfaces/PlayerEvents.md deleted file mode 100644 index acef0f0..0000000 --- a/src/content/docs/api/interfaces/PlayerEvents.md +++ /dev/null @@ -1,118 +0,0 @@ ---- -editUrl: false -next: false -prev: false -title: "PlayerEvents" ---- - -## Events - - - -### closed - -```ts -closed: [WebSocketClosedEvent]; -``` - -Emitted when the current websocket connection is closed - -#### Defined in - -[guild/Player.ts:141](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L141) - -*** - - - -### end - -```ts -end: [TrackEndEvent]; -``` - -Emitted when the current playing track ends - -#### Defined in - -[guild/Player.ts:131](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L131) - -*** - - - -### exception - -```ts -exception: [TrackExceptionEvent]; -``` - -Emitted when there is an error caused by the current playing track - -#### Defined in - -[guild/Player.ts:151](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L151) - -*** - - - -### resumed - -```ts -resumed: [Player]; -``` - -Emitted when the library manages to resume the player - -#### Defined in - -[guild/Player.ts:156](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L156) - -*** - - - -### start - -```ts -start: [TrackStartEvent]; -``` - -Emitted when a new track starts - -#### Defined in - -[guild/Player.ts:146](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L146) - -*** - - - -### stuck - -```ts -stuck: [TrackStuckEvent]; -``` - -Emitted when the current playing track gets stuck due to an error - -#### Defined in - -[guild/Player.ts:136](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L136) - -*** - - - -### update - -```ts -update: [PlayerUpdate]; -``` - -Emitted when a playerUpdate even is received from Lavalink - -#### Defined in - -[guild/Player.ts:161](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L161) diff --git a/src/content/docs/api/interfaces/PlayerUpdate.md b/src/content/docs/api/interfaces/PlayerUpdate.md index 98009a1..cbfe84a 100644 --- a/src/content/docs/api/interfaces/PlayerUpdate.md +++ b/src/content/docs/api/interfaces/PlayerUpdate.md @@ -17,7 +17,7 @@ guildId: string; #### Defined in -[guild/Player.ts:110](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L110) +[shoukaku/src/guild/Player.ts:110](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L110) *** @@ -31,7 +31,7 @@ op: PLAYER_UPDATE; #### Defined in -[guild/Player.ts:103](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L103) +[shoukaku/src/guild/Player.ts:103](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L103) *** @@ -82,4 +82,4 @@ time: number; #### Defined in -[guild/Player.ts:104](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L104) +[shoukaku/src/guild/Player.ts:104](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L104) diff --git a/src/content/docs/api/interfaces/Playlist.md b/src/content/docs/api/interfaces/Playlist.md index 3414367..ee2d0c5 100644 --- a/src/content/docs/api/interfaces/Playlist.md +++ b/src/content/docs/api/interfaces/Playlist.md @@ -17,7 +17,7 @@ encoded: string; #### Defined in -[node/Rest.ts:35](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Rest.ts#L35) +[shoukaku/src/node/Rest.ts:35](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Rest.ts#L35) *** @@ -50,7 +50,7 @@ selectedTrack: number; #### Defined in -[node/Rest.ts:36](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Rest.ts#L36) +[shoukaku/src/node/Rest.ts:36](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Rest.ts#L36) *** @@ -64,7 +64,7 @@ pluginInfo: unknown; #### Defined in -[node/Rest.ts:40](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Rest.ts#L40) +[shoukaku/src/node/Rest.ts:40](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Rest.ts#L40) *** @@ -78,4 +78,4 @@ tracks: Track[]; #### Defined in -[node/Rest.ts:41](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Rest.ts#L41) +[shoukaku/src/node/Rest.ts:41](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Rest.ts#L41) diff --git a/src/content/docs/api/interfaces/PlaylistResult.md b/src/content/docs/api/interfaces/PlaylistResult.md index 9ad0b32..2f154ec 100644 --- a/src/content/docs/api/interfaces/PlaylistResult.md +++ b/src/content/docs/api/interfaces/PlaylistResult.md @@ -17,7 +17,7 @@ data: Playlist; #### Defined in -[node/Rest.ts:57](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Rest.ts#L57) +[shoukaku/src/node/Rest.ts:57](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Rest.ts#L57) *** @@ -31,4 +31,4 @@ loadType: PLAYLIST; #### Defined in -[node/Rest.ts:56](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Rest.ts#L56) +[shoukaku/src/node/Rest.ts:56](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Rest.ts#L56) diff --git a/src/content/docs/api/interfaces/Ready.md b/src/content/docs/api/interfaces/Ready.md index 7c81d67..6b209ce 100644 --- a/src/content/docs/api/interfaces/Ready.md +++ b/src/content/docs/api/interfaces/Ready.md @@ -17,7 +17,7 @@ op: READY; #### Defined in -[node/Node.ts:11](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Node.ts#L11) +[shoukaku/src/node/Node.ts:10](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Node.ts#L10) *** @@ -31,7 +31,7 @@ resumed: boolean; #### Defined in -[node/Node.ts:12](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Node.ts#L12) +[shoukaku/src/node/Node.ts:11](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Node.ts#L11) *** @@ -45,4 +45,4 @@ sessionId: string; #### Defined in -[node/Node.ts:13](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Node.ts#L13) +[shoukaku/src/node/Node.ts:12](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Node.ts#L12) diff --git a/src/content/docs/api/interfaces/ResumableHeaders.md b/src/content/docs/api/interfaces/ResumableHeaders.md index c1c4eb8..2afa0c6 100644 --- a/src/content/docs/api/interfaces/ResumableHeaders.md +++ b/src/content/docs/api/interfaces/ResumableHeaders.md @@ -21,7 +21,7 @@ Authorization: string; #### Defined in -[node/Node.ts:74](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Node.ts#L74) +[shoukaku/src/node/Node.ts:73](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Node.ts#L73) *** @@ -35,7 +35,7 @@ Client-Name: string; #### Defined in -[node/Node.ts:72](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Node.ts#L72) +[shoukaku/src/node/Node.ts:71](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Node.ts#L71) *** @@ -49,7 +49,7 @@ Session-Id: string; #### Defined in -[node/Node.ts:76](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Node.ts#L76) +[shoukaku/src/node/Node.ts:75](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Node.ts#L75) *** @@ -63,7 +63,7 @@ User-Agent: string; #### Defined in -[node/Node.ts:73](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Node.ts#L73) +[shoukaku/src/node/Node.ts:72](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Node.ts#L72) *** @@ -77,4 +77,4 @@ User-Id: string; #### Defined in -[node/Node.ts:75](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Node.ts#L75) +[shoukaku/src/node/Node.ts:74](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Node.ts#L74) diff --git a/src/content/docs/api/interfaces/RotationSettings.md b/src/content/docs/api/interfaces/RotationSettings.md index 826060f..211fc5a 100644 --- a/src/content/docs/api/interfaces/RotationSettings.md +++ b/src/content/docs/api/interfaces/RotationSettings.md @@ -17,4 +17,4 @@ optional rotationHz: number; #### Defined in -[guild/Player.ts:43](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L43) +[shoukaku/src/guild/Player.ts:43](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L43) diff --git a/src/content/docs/api/interfaces/RoutePlanner.md b/src/content/docs/api/interfaces/RoutePlanner.md index 96b1f6d..c5f4976 100644 --- a/src/content/docs/api/interfaces/RoutePlanner.md +++ b/src/content/docs/api/interfaces/RoutePlanner.md @@ -22,7 +22,7 @@ class: #### Defined in -[node/Rest.ts:84](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Rest.ts#L84) +[shoukaku/src/node/Rest.ts:84](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Rest.ts#L84) *** @@ -47,4 +47,4 @@ details: null | { #### Defined in -[node/Rest.ts:85](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Rest.ts#L85) +[shoukaku/src/node/Rest.ts:85](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Rest.ts#L85) diff --git a/src/content/docs/api/interfaces/SearchResult.md b/src/content/docs/api/interfaces/SearchResult.md index ac5c880..a13c5dc 100644 --- a/src/content/docs/api/interfaces/SearchResult.md +++ b/src/content/docs/api/interfaces/SearchResult.md @@ -17,7 +17,7 @@ data: Track[]; #### Defined in -[node/Rest.ts:62](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Rest.ts#L62) +[shoukaku/src/node/Rest.ts:62](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Rest.ts#L62) *** @@ -31,4 +31,4 @@ loadType: SEARCH; #### Defined in -[node/Rest.ts:61](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Rest.ts#L61) +[shoukaku/src/node/Rest.ts:61](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Rest.ts#L61) diff --git a/src/content/docs/api/interfaces/ServerUpdate.md b/src/content/docs/api/interfaces/ServerUpdate.md index 78f7a5f..4ec38f7 100644 --- a/src/content/docs/api/interfaces/ServerUpdate.md +++ b/src/content/docs/api/interfaces/ServerUpdate.md @@ -19,7 +19,7 @@ endpoint: string; #### Defined in -[guild/Connection.ts:21](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Connection.ts#L21) +[shoukaku/src/guild/Connection.ts:21](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Connection.ts#L21) *** @@ -33,7 +33,7 @@ guild_id: string; #### Defined in -[guild/Connection.ts:20](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Connection.ts#L20) +[shoukaku/src/guild/Connection.ts:20](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Connection.ts#L20) *** @@ -47,4 +47,4 @@ token: string; #### Defined in -[guild/Connection.ts:19](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Connection.ts#L19) +[shoukaku/src/guild/Connection.ts:19](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Connection.ts#L19) diff --git a/src/content/docs/api/interfaces/SessionInfo.md b/src/content/docs/api/interfaces/SessionInfo.md index 3ac3440..7d31d0d 100644 --- a/src/content/docs/api/interfaces/SessionInfo.md +++ b/src/content/docs/api/interfaces/SessionInfo.md @@ -17,7 +17,7 @@ optional resumingKey: string; #### Defined in -[node/Rest.ts:141](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Rest.ts#L141) +[shoukaku/src/node/Rest.ts:141](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Rest.ts#L141) *** @@ -31,4 +31,4 @@ timeout: number; #### Defined in -[node/Rest.ts:142](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Rest.ts#L142) +[shoukaku/src/node/Rest.ts:142](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Rest.ts#L142) diff --git a/src/content/docs/api/interfaces/ShoukakuEvents.md b/src/content/docs/api/interfaces/ShoukakuEvents.md deleted file mode 100644 index a309d16..0000000 --- a/src/content/docs/api/interfaces/ShoukakuEvents.md +++ /dev/null @@ -1,118 +0,0 @@ ---- -editUrl: false -next: false -prev: false -title: "ShoukakuEvents" ---- - -## Events - - - -### close - -```ts -close: [string, number, string]; -``` - -Emitted when a websocket connection to Lavalink closes - -#### Defined in - -[Shoukaku.ts:124](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/Shoukaku.ts#L124) - -*** - - - -### debug - -```ts -debug: [string, string]; -``` - -Emitted when data useful for debugging is produced - -#### Defined in - -[Shoukaku.ts:109](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/Shoukaku.ts#L109) - -*** - - - -### disconnect - -```ts -disconnect: [string, number]; -``` - -Emitted when a websocket connection to Lavalink disconnects - -#### Defined in - -[Shoukaku.ts:129](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/Shoukaku.ts#L129) - -*** - - - -### error - -```ts -error: [string, Error]; -``` - -Emitted when an error occurs - -#### Defined in - -[Shoukaku.ts:114](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/Shoukaku.ts#L114) - -*** - - - -### raw - -```ts -raw: [string, unknown]; -``` - -Emitted when a raw message is received from Lavalink - -#### Defined in - -[Shoukaku.ts:134](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/Shoukaku.ts#L134) - -*** - - - -### ready - -```ts -ready: [string, boolean]; -``` - -Emitted when Shoukaku is ready to receive operations - -#### Defined in - -[Shoukaku.ts:119](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/Shoukaku.ts#L119) - -*** - - - -### reconnecting - -```ts -reconnecting: [string, number, number]; -``` - -Emitted when reconnect tries are occurring and how many tries are left - -#### Defined in - -[Shoukaku.ts:104](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/Shoukaku.ts#L104) diff --git a/src/content/docs/api/interfaces/ShoukakuOptions.md b/src/content/docs/api/interfaces/ShoukakuOptions.md index 53eefb8..c32dbc8 100644 --- a/src/content/docs/api/interfaces/ShoukakuOptions.md +++ b/src/content/docs/api/interfaces/ShoukakuOptions.md @@ -19,7 +19,7 @@ Whether to move players to a different Lavalink node when a node disconnects #### Defined in -[Shoukaku.ts:72](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/Shoukaku.ts#L72) +[shoukaku/src/Shoukaku.ts:71](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/Shoukaku.ts#L71) *** @@ -46,7 +46,7 @@ Node Resolver to use if you want to customize it #### Defined in -[Shoukaku.ts:88](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/Shoukaku.ts#L88) +[shoukaku/src/Shoukaku.ts:87](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/Shoukaku.ts#L87) *** @@ -62,7 +62,7 @@ Timeout before trying to reconnect #### Defined in -[Shoukaku.ts:64](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/Shoukaku.ts#L64) +[shoukaku/src/Shoukaku.ts:63](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/Shoukaku.ts#L63) *** @@ -78,7 +78,7 @@ Number of times to try and reconnect to Lavalink before giving up #### Defined in -[Shoukaku.ts:60](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/Shoukaku.ts#L60) +[shoukaku/src/Shoukaku.ts:59](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/Shoukaku.ts#L59) *** @@ -94,7 +94,7 @@ Time to wait for a response from the Lavalink REST API before giving up #### Defined in -[Shoukaku.ts:68](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/Shoukaku.ts#L68) +[shoukaku/src/Shoukaku.ts:67](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/Shoukaku.ts#L67) *** @@ -110,7 +110,7 @@ Whether to resume a connection on disconnect to Lavalink (Server Side) (Note: DO #### Defined in -[Shoukaku.ts:48](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/Shoukaku.ts#L48) +[shoukaku/src/Shoukaku.ts:47](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/Shoukaku.ts#L47) *** @@ -126,7 +126,7 @@ Whether to resume the players by doing it in the library side (Client Side) (Not #### Defined in -[Shoukaku.ts:56](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/Shoukaku.ts#L56) +[shoukaku/src/Shoukaku.ts:55](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/Shoukaku.ts#L55) *** @@ -142,7 +142,7 @@ Time to wait before lavalink starts to destroy the players of the disconnected c #### Defined in -[Shoukaku.ts:52](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/Shoukaku.ts#L52) +[shoukaku/src/Shoukaku.ts:51](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/Shoukaku.ts#L51) *** @@ -158,7 +158,7 @@ Custom structures for shoukaku to use #### Defined in -[Shoukaku.ts:80](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/Shoukaku.ts#L80) +[shoukaku/src/Shoukaku.ts:79](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/Shoukaku.ts#L79) *** @@ -174,7 +174,7 @@ User Agent to use when making requests to Lavalink #### Defined in -[Shoukaku.ts:76](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/Shoukaku.ts#L76) +[shoukaku/src/Shoukaku.ts:75](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/Shoukaku.ts#L75) *** @@ -190,4 +190,4 @@ Timeout before abort connection #### Defined in -[Shoukaku.ts:84](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/Shoukaku.ts#L84) +[shoukaku/src/Shoukaku.ts:83](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/Shoukaku.ts#L83) diff --git a/src/content/docs/api/interfaces/StateUpdatePartial.md b/src/content/docs/api/interfaces/StateUpdatePartial.md index 530a0f2..f16aa11 100644 --- a/src/content/docs/api/interfaces/StateUpdatePartial.md +++ b/src/content/docs/api/interfaces/StateUpdatePartial.md @@ -19,7 +19,7 @@ optional channel_id: string; #### Defined in -[guild/Connection.ts:9](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Connection.ts#L9) +[shoukaku/src/guild/Connection.ts:9](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Connection.ts#L9) *** @@ -33,7 +33,7 @@ self_deaf: boolean; #### Defined in -[guild/Connection.ts:11](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Connection.ts#L11) +[shoukaku/src/guild/Connection.ts:11](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Connection.ts#L11) *** @@ -47,7 +47,7 @@ self_mute: boolean; #### Defined in -[guild/Connection.ts:12](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Connection.ts#L12) +[shoukaku/src/guild/Connection.ts:12](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Connection.ts#L12) *** @@ -61,4 +61,4 @@ optional session_id: string; #### Defined in -[guild/Connection.ts:10](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Connection.ts#L10) +[shoukaku/src/guild/Connection.ts:10](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Connection.ts#L10) diff --git a/src/content/docs/api/interfaces/Stats.md b/src/content/docs/api/interfaces/Stats.md index f8148aa..028f2ec 100644 --- a/src/content/docs/api/interfaces/Stats.md +++ b/src/content/docs/api/interfaces/Stats.md @@ -45,7 +45,7 @@ systemLoad: number; #### Defined in -[node/Node.ts:31](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Node.ts#L31) +[shoukaku/src/node/Node.ts:30](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Node.ts#L30) *** @@ -87,7 +87,7 @@ sent: number; #### Defined in -[node/Node.ts:26](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Node.ts#L26) +[shoukaku/src/node/Node.ts:25](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Node.ts#L25) *** @@ -138,7 +138,7 @@ used: number; #### Defined in -[node/Node.ts:20](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Node.ts#L20) +[shoukaku/src/node/Node.ts:19](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Node.ts#L19) *** @@ -152,7 +152,7 @@ op: STATS; #### Defined in -[node/Node.ts:17](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Node.ts#L17) +[shoukaku/src/node/Node.ts:16](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Node.ts#L16) *** @@ -166,7 +166,7 @@ players: number; #### Defined in -[node/Node.ts:18](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Node.ts#L18) +[shoukaku/src/node/Node.ts:17](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Node.ts#L17) *** @@ -180,7 +180,7 @@ playingPlayers: number; #### Defined in -[node/Node.ts:19](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Node.ts#L19) +[shoukaku/src/node/Node.ts:18](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Node.ts#L18) *** @@ -194,4 +194,4 @@ uptime: number; #### Defined in -[node/Node.ts:36](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Node.ts#L36) +[shoukaku/src/node/Node.ts:35](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Node.ts#L35) diff --git a/src/content/docs/api/interfaces/Structures.md b/src/content/docs/api/interfaces/Structures.md index e15b479..56e1d15 100644 --- a/src/content/docs/api/interfaces/Structures.md +++ b/src/content/docs/api/interfaces/Structures.md @@ -19,7 +19,7 @@ A custom structure that extends the Player class #### Defined in -[Shoukaku.ts:18](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/Shoukaku.ts#L18) +[shoukaku/src/Shoukaku.ts:17](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/Shoukaku.ts#L17) *** @@ -35,4 +35,4 @@ A custom structure that extends the Rest class #### Defined in -[Shoukaku.ts:14](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/Shoukaku.ts#L14) +[shoukaku/src/Shoukaku.ts:13](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/Shoukaku.ts#L13) diff --git a/src/content/docs/api/interfaces/TimescaleSettings.md b/src/content/docs/api/interfaces/TimescaleSettings.md index 5258cbc..0dd3065 100644 --- a/src/content/docs/api/interfaces/TimescaleSettings.md +++ b/src/content/docs/api/interfaces/TimescaleSettings.md @@ -17,7 +17,7 @@ optional pitch: number; #### Defined in -[guild/Player.ts:33](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L33) +[shoukaku/src/guild/Player.ts:33](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L33) *** @@ -31,7 +31,7 @@ optional rate: number; #### Defined in -[guild/Player.ts:34](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L34) +[shoukaku/src/guild/Player.ts:34](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L34) *** @@ -45,4 +45,4 @@ optional speed: number; #### Defined in -[guild/Player.ts:32](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L32) +[shoukaku/src/guild/Player.ts:32](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L32) diff --git a/src/content/docs/api/interfaces/Track.md b/src/content/docs/api/interfaces/Track.md index 332564e..9bd7d3c 100644 --- a/src/content/docs/api/interfaces/Track.md +++ b/src/content/docs/api/interfaces/Track.md @@ -17,7 +17,7 @@ encoded: string; #### Defined in -[node/Rest.ts:17](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Rest.ts#L17) +[shoukaku/src/node/Rest.ts:17](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Rest.ts#L17) *** @@ -131,7 +131,7 @@ optional uri: string; #### Defined in -[node/Rest.ts:18](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Rest.ts#L18) +[shoukaku/src/node/Rest.ts:18](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Rest.ts#L18) *** @@ -145,4 +145,4 @@ pluginInfo: unknown; #### Defined in -[node/Rest.ts:31](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Rest.ts#L31) +[shoukaku/src/node/Rest.ts:31](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Rest.ts#L31) diff --git a/src/content/docs/api/interfaces/TrackEndEvent.md b/src/content/docs/api/interfaces/TrackEndEvent.md index de55363..5aa8f8a 100644 --- a/src/content/docs/api/interfaces/TrackEndEvent.md +++ b/src/content/docs/api/interfaces/TrackEndEvent.md @@ -25,7 +25,7 @@ guildId: string; #### Defined in -[guild/Player.ts:70](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L70) +[shoukaku/src/guild/Player.ts:70](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L70) *** @@ -43,7 +43,7 @@ op: EVENT; #### Defined in -[guild/Player.ts:69](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L69) +[shoukaku/src/guild/Player.ts:69](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L69) *** @@ -57,7 +57,7 @@ reason: TrackEndReason; #### Defined in -[guild/Player.ts:81](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L81) +[shoukaku/src/guild/Player.ts:81](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L81) *** @@ -71,7 +71,7 @@ track: Track; #### Defined in -[guild/Player.ts:80](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L80) +[shoukaku/src/guild/Player.ts:80](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L80) *** @@ -85,4 +85,4 @@ type: TRACK_END_EVENT; #### Defined in -[guild/Player.ts:79](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L79) +[shoukaku/src/guild/Player.ts:79](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L79) diff --git a/src/content/docs/api/interfaces/TrackExceptionEvent.md b/src/content/docs/api/interfaces/TrackExceptionEvent.md index 9d2b064..fd7edb4 100644 --- a/src/content/docs/api/interfaces/TrackExceptionEvent.md +++ b/src/content/docs/api/interfaces/TrackExceptionEvent.md @@ -21,7 +21,7 @@ exception: Exception; #### Defined in -[guild/Player.ts:92](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L92) +[shoukaku/src/guild/Player.ts:92](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L92) *** @@ -39,7 +39,7 @@ guildId: string; #### Defined in -[guild/Player.ts:70](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L70) +[shoukaku/src/guild/Player.ts:70](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L70) *** @@ -57,7 +57,7 @@ op: EVENT; #### Defined in -[guild/Player.ts:69](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L69) +[shoukaku/src/guild/Player.ts:69](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L69) *** @@ -71,4 +71,4 @@ type: TRACK_EXCEPTION_EVENT; #### Defined in -[guild/Player.ts:91](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L91) +[shoukaku/src/guild/Player.ts:91](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L91) diff --git a/src/content/docs/api/interfaces/TrackResult.md b/src/content/docs/api/interfaces/TrackResult.md index 24da854..6d5107b 100644 --- a/src/content/docs/api/interfaces/TrackResult.md +++ b/src/content/docs/api/interfaces/TrackResult.md @@ -17,7 +17,7 @@ data: Track; #### Defined in -[node/Rest.ts:52](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Rest.ts#L52) +[shoukaku/src/node/Rest.ts:52](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Rest.ts#L52) *** @@ -31,4 +31,4 @@ loadType: TRACK; #### Defined in -[node/Rest.ts:51](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Rest.ts#L51) +[shoukaku/src/node/Rest.ts:51](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Rest.ts#L51) diff --git a/src/content/docs/api/interfaces/TrackStartEvent.md b/src/content/docs/api/interfaces/TrackStartEvent.md index 796d38c..f4ec32a 100644 --- a/src/content/docs/api/interfaces/TrackStartEvent.md +++ b/src/content/docs/api/interfaces/TrackStartEvent.md @@ -25,7 +25,7 @@ guildId: string; #### Defined in -[guild/Player.ts:70](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L70) +[shoukaku/src/guild/Player.ts:70](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L70) *** @@ -43,7 +43,7 @@ op: EVENT; #### Defined in -[guild/Player.ts:69](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L69) +[shoukaku/src/guild/Player.ts:69](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L69) *** @@ -57,7 +57,7 @@ track: Track; #### Defined in -[guild/Player.ts:75](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L75) +[shoukaku/src/guild/Player.ts:75](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L75) *** @@ -71,4 +71,4 @@ type: TRACK_START_EVENT; #### Defined in -[guild/Player.ts:74](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L74) +[shoukaku/src/guild/Player.ts:74](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L74) diff --git a/src/content/docs/api/interfaces/TrackStuckEvent.md b/src/content/docs/api/interfaces/TrackStuckEvent.md index e23ff7e..c358275 100644 --- a/src/content/docs/api/interfaces/TrackStuckEvent.md +++ b/src/content/docs/api/interfaces/TrackStuckEvent.md @@ -25,7 +25,7 @@ guildId: string; #### Defined in -[guild/Player.ts:70](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L70) +[shoukaku/src/guild/Player.ts:70](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L70) *** @@ -43,7 +43,7 @@ op: EVENT; #### Defined in -[guild/Player.ts:69](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L69) +[shoukaku/src/guild/Player.ts:69](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L69) *** @@ -57,7 +57,7 @@ thresholdMs: number; #### Defined in -[guild/Player.ts:87](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L87) +[shoukaku/src/guild/Player.ts:87](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L87) *** @@ -71,7 +71,7 @@ track: Track; #### Defined in -[guild/Player.ts:86](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L86) +[shoukaku/src/guild/Player.ts:86](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L86) *** @@ -85,4 +85,4 @@ type: TRACK_STUCK_EVENT; #### Defined in -[guild/Player.ts:85](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L85) +[shoukaku/src/guild/Player.ts:85](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L85) diff --git a/src/content/docs/api/interfaces/UpdatePlayerInfo.md b/src/content/docs/api/interfaces/UpdatePlayerInfo.md index 8eb72c1..9e1d9e0 100644 --- a/src/content/docs/api/interfaces/UpdatePlayerInfo.md +++ b/src/content/docs/api/interfaces/UpdatePlayerInfo.md @@ -17,7 +17,7 @@ guildId: string; #### Defined in -[node/Rest.ts:135](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Rest.ts#L135) +[shoukaku/src/node/Rest.ts:135](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Rest.ts#L135) *** @@ -31,7 +31,7 @@ optional noReplace: boolean; #### Defined in -[node/Rest.ts:137](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Rest.ts#L137) +[shoukaku/src/node/Rest.ts:137](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Rest.ts#L137) *** @@ -45,4 +45,4 @@ playerOptions: UpdatePlayerOptions; #### Defined in -[node/Rest.ts:136](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Rest.ts#L136) +[shoukaku/src/node/Rest.ts:136](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Rest.ts#L136) diff --git a/src/content/docs/api/interfaces/UpdatePlayerOptions.md b/src/content/docs/api/interfaces/UpdatePlayerOptions.md index 07cecf0..3755470 100644 --- a/src/content/docs/api/interfaces/UpdatePlayerOptions.md +++ b/src/content/docs/api/interfaces/UpdatePlayerOptions.md @@ -17,7 +17,7 @@ optional endTime: number; #### Defined in -[node/Rest.ts:127](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Rest.ts#L127) +[shoukaku/src/node/Rest.ts:127](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Rest.ts#L127) *** @@ -31,7 +31,7 @@ optional filters: FilterOptions; #### Defined in -[node/Rest.ts:130](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Rest.ts#L130) +[shoukaku/src/node/Rest.ts:130](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Rest.ts#L130) *** @@ -45,7 +45,7 @@ optional paused: boolean; #### Defined in -[node/Rest.ts:129](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Rest.ts#L129) +[shoukaku/src/node/Rest.ts:129](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Rest.ts#L129) *** @@ -59,7 +59,7 @@ optional position: number; #### Defined in -[node/Rest.ts:126](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Rest.ts#L126) +[shoukaku/src/node/Rest.ts:126](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Rest.ts#L126) *** @@ -73,7 +73,7 @@ optional track: UpdatePlayerTrackOptions; #### Defined in -[node/Rest.ts:125](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Rest.ts#L125) +[shoukaku/src/node/Rest.ts:125](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Rest.ts#L125) *** @@ -87,7 +87,7 @@ optional voice: LavalinkPlayerVoiceOptions; #### Defined in -[node/Rest.ts:131](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Rest.ts#L131) +[shoukaku/src/node/Rest.ts:131](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Rest.ts#L131) *** @@ -101,4 +101,4 @@ optional volume: number; #### Defined in -[node/Rest.ts:128](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Rest.ts#L128) +[shoukaku/src/node/Rest.ts:128](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Rest.ts#L128) diff --git a/src/content/docs/api/interfaces/UpdatePlayerTrackOptions.md b/src/content/docs/api/interfaces/UpdatePlayerTrackOptions.md index a9be93d..88fdb7b 100644 --- a/src/content/docs/api/interfaces/UpdatePlayerTrackOptions.md +++ b/src/content/docs/api/interfaces/UpdatePlayerTrackOptions.md @@ -17,7 +17,7 @@ optional encoded: null | string; #### Defined in -[node/Rest.ts:119](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Rest.ts#L119) +[shoukaku/src/node/Rest.ts:119](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Rest.ts#L119) *** @@ -31,7 +31,7 @@ optional identifier: string; #### Defined in -[node/Rest.ts:120](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Rest.ts#L120) +[shoukaku/src/node/Rest.ts:120](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Rest.ts#L120) *** @@ -45,4 +45,4 @@ optional userData: unknown; #### Defined in -[node/Rest.ts:121](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Rest.ts#L121) +[shoukaku/src/node/Rest.ts:121](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Rest.ts#L121) diff --git a/src/content/docs/api/interfaces/VoiceChannelOptions.md b/src/content/docs/api/interfaces/VoiceChannelOptions.md index 67e7d93..a823d0e 100644 --- a/src/content/docs/api/interfaces/VoiceChannelOptions.md +++ b/src/content/docs/api/interfaces/VoiceChannelOptions.md @@ -17,7 +17,7 @@ channelId: string; #### Defined in -[Shoukaku.ts:94](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/Shoukaku.ts#L94) +[shoukaku/src/Shoukaku.ts:93](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/Shoukaku.ts#L93) *** @@ -31,7 +31,7 @@ optional deaf: boolean; #### Defined in -[Shoukaku.ts:95](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/Shoukaku.ts#L95) +[shoukaku/src/Shoukaku.ts:94](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/Shoukaku.ts#L94) *** @@ -45,7 +45,7 @@ guildId: string; #### Defined in -[Shoukaku.ts:92](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/Shoukaku.ts#L92) +[shoukaku/src/Shoukaku.ts:91](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/Shoukaku.ts#L91) *** @@ -59,7 +59,7 @@ optional mute: boolean; #### Defined in -[Shoukaku.ts:96](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/Shoukaku.ts#L96) +[shoukaku/src/Shoukaku.ts:95](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/Shoukaku.ts#L95) *** @@ -73,4 +73,4 @@ shardId: number; #### Defined in -[Shoukaku.ts:93](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/Shoukaku.ts#L93) +[shoukaku/src/Shoukaku.ts:92](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/Shoukaku.ts#L92) diff --git a/src/content/docs/api/interfaces/WebSocketClosedEvent.md b/src/content/docs/api/interfaces/WebSocketClosedEvent.md index bbc313c..64b9ed6 100644 --- a/src/content/docs/api/interfaces/WebSocketClosedEvent.md +++ b/src/content/docs/api/interfaces/WebSocketClosedEvent.md @@ -21,7 +21,7 @@ byRemote: boolean; #### Defined in -[guild/Player.ts:98](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L98) +[shoukaku/src/guild/Player.ts:98](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L98) *** @@ -35,7 +35,7 @@ code: number; #### Defined in -[guild/Player.ts:97](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L97) +[shoukaku/src/guild/Player.ts:97](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L97) *** @@ -53,7 +53,7 @@ guildId: string; #### Defined in -[guild/Player.ts:70](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L70) +[shoukaku/src/guild/Player.ts:70](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L70) *** @@ -71,7 +71,7 @@ op: EVENT; #### Defined in -[guild/Player.ts:69](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L69) +[shoukaku/src/guild/Player.ts:69](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L69) *** @@ -85,7 +85,7 @@ reason: string; #### Defined in -[guild/Player.ts:99](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L99) +[shoukaku/src/guild/Player.ts:99](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L99) *** @@ -99,4 +99,4 @@ type: WEBSOCKET_CLOSED_EVENT; #### Defined in -[guild/Player.ts:96](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L96) +[shoukaku/src/guild/Player.ts:96](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L96) diff --git a/src/content/docs/api/namespaces/Connectors/classes/DiscordJS.md b/src/content/docs/api/namespaces/Connectors/classes/DiscordJS.md index 2bf9f14..08835f7 100644 --- a/src/content/docs/api/namespaces/Connectors/classes/DiscordJS.md +++ b/src/content/docs/api/namespaces/Connectors/classes/DiscordJS.md @@ -35,7 +35,7 @@ new DiscordJS(client: any): DiscordJS #### 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 @@ -57,7 +57,7 @@ getId(): string #### Defined in -[connectors/libs/DiscordJS.ts:10](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/connectors/libs/DiscordJS.ts#L10) +[shoukaku/src/connectors/libs/DiscordJS.ts:11](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/connectors/libs/DiscordJS.ts#L11) *** @@ -85,7 +85,7 @@ listen(nodes: NodeOption[]): void #### Defined in -[connectors/libs/DiscordJS.ts:14](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/connectors/libs/DiscordJS.ts#L14) +[shoukaku/src/connectors/libs/DiscordJS.ts:15](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/connectors/libs/DiscordJS.ts#L15) *** @@ -118,7 +118,7 @@ sendPacket( #### Defined in -[connectors/libs/DiscordJS.ts:6](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/connectors/libs/DiscordJS.ts#L6) +[shoukaku/src/connectors/libs/DiscordJS.ts:7](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/connectors/libs/DiscordJS.ts#L7) *** @@ -146,4 +146,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) diff --git a/src/content/docs/api/namespaces/Connectors/classes/Eris.md b/src/content/docs/api/namespaces/Connectors/classes/Eris.md index 44d4c8c..f703b63 100644 --- a/src/content/docs/api/namespaces/Connectors/classes/Eris.md +++ b/src/content/docs/api/namespaces/Connectors/classes/Eris.md @@ -35,7 +35,7 @@ new Eris(client: any): Eris #### 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 @@ -57,7 +57,7 @@ getId(): string #### Defined in -[connectors/libs/Eris.ts:10](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/connectors/libs/Eris.ts#L10) +[shoukaku/src/connectors/libs/Eris.ts:11](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/connectors/libs/Eris.ts#L11) *** @@ -85,7 +85,7 @@ listen(nodes: NodeOption[]): void #### Defined in -[connectors/libs/Eris.ts:14](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/connectors/libs/Eris.ts#L14) +[shoukaku/src/connectors/libs/Eris.ts:15](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/connectors/libs/Eris.ts#L15) *** @@ -118,7 +118,7 @@ sendPacket( #### Defined in -[connectors/libs/Eris.ts:6](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/connectors/libs/Eris.ts#L6) +[shoukaku/src/connectors/libs/Eris.ts:7](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/connectors/libs/Eris.ts#L7) *** @@ -146,4 +146,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) diff --git a/src/content/docs/api/namespaces/Connectors/classes/OceanicJS.md b/src/content/docs/api/namespaces/Connectors/classes/OceanicJS.md index b22e88b..09e9ff5 100644 --- a/src/content/docs/api/namespaces/Connectors/classes/OceanicJS.md +++ b/src/content/docs/api/namespaces/Connectors/classes/OceanicJS.md @@ -35,7 +35,7 @@ new OceanicJS(client: any): OceanicJS #### 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 @@ -57,7 +57,7 @@ getId(): string #### Defined in -[connectors/libs/OceanicJS.ts:10](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/connectors/libs/OceanicJS.ts#L10) +[shoukaku/src/connectors/libs/OceanicJS.ts:11](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/connectors/libs/OceanicJS.ts#L11) *** @@ -85,7 +85,7 @@ listen(nodes: NodeOption[]): void #### Defined in -[connectors/libs/OceanicJS.ts:14](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/connectors/libs/OceanicJS.ts#L14) +[shoukaku/src/connectors/libs/OceanicJS.ts:15](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/connectors/libs/OceanicJS.ts#L15) *** @@ -118,7 +118,7 @@ sendPacket( #### Defined in -[connectors/libs/OceanicJS.ts:6](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/connectors/libs/OceanicJS.ts#L6) +[shoukaku/src/connectors/libs/OceanicJS.ts:7](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/connectors/libs/OceanicJS.ts#L7) *** @@ -146,4 +146,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) diff --git a/src/content/docs/api/namespaces/Connectors/classes/Seyfert.md b/src/content/docs/api/namespaces/Connectors/classes/Seyfert.md index 54aa7ab..f63a94a 100644 --- a/src/content/docs/api/namespaces/Connectors/classes/Seyfert.md +++ b/src/content/docs/api/namespaces/Connectors/classes/Seyfert.md @@ -35,7 +35,7 @@ new Seyfert(client: any): Seyfert #### 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 @@ -57,7 +57,7 @@ getId(): string #### Defined in -[connectors/libs/Seyfert.ts:10](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/connectors/libs/Seyfert.ts#L10) +[shoukaku/src/connectors/libs/Seyfert.ts:11](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/connectors/libs/Seyfert.ts#L11) *** @@ -85,7 +85,7 @@ listen(nodes: NodeOption[]): void #### Defined in -[connectors/libs/Seyfert.ts:14](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/connectors/libs/Seyfert.ts#L14) +[shoukaku/src/connectors/libs/Seyfert.ts:15](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/connectors/libs/Seyfert.ts#L15) *** @@ -96,7 +96,7 @@ listen(nodes: NodeOption[]): void ```ts sendPacket( shardId: number, - payload: any, + payload: unknown, important: boolean): void ``` @@ -105,7 +105,7 @@ sendPacket( | Parameter | Type | | ------ | ------ | | `shardId` | `number` | -| `payload` | `any` | +| `payload` | `unknown` | | `important` | `boolean` | #### Returns @@ -118,7 +118,7 @@ sendPacket( #### Defined in -[connectors/libs/Seyfert.ts:6](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/connectors/libs/Seyfert.ts#L6) +[shoukaku/src/connectors/libs/Seyfert.ts:7](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/connectors/libs/Seyfert.ts#L7) *** @@ -146,4 +146,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) diff --git a/src/content/docs/api/namespaces/Constants/enumerations/OpCodes.md b/src/content/docs/api/namespaces/Constants/enumerations/OpCodes.md index b9d93d4..909d1db 100644 --- a/src/content/docs/api/namespaces/Constants/enumerations/OpCodes.md +++ b/src/content/docs/api/namespaces/Constants/enumerations/OpCodes.md @@ -9,7 +9,7 @@ title: "OpCodes" | Enumeration Member | Value | Defined in | | ------ | ------ | ------ | -| `EVENT` | `"event"` | [Constants.ts:23](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/Constants.ts#L23) | -| `PLAYER_UPDATE` | `"playerUpdate"` | [Constants.ts:21](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/Constants.ts#L21) | -| `READY` | `"ready"` | [Constants.ts:24](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/Constants.ts#L24) | -| `STATS` | `"stats"` | [Constants.ts:22](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/Constants.ts#L22) | +| `EVENT` | `"event"` | [shoukaku/src/Constants.ts:23](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/Constants.ts#L23) | +| `PLAYER_UPDATE` | `"playerUpdate"` | [shoukaku/src/Constants.ts:21](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/Constants.ts#L21) | +| `READY` | `"ready"` | [shoukaku/src/Constants.ts:24](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/Constants.ts#L24) | +| `STATS` | `"stats"` | [shoukaku/src/Constants.ts:22](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/Constants.ts#L22) | diff --git a/src/content/docs/api/namespaces/Constants/enumerations/State.md b/src/content/docs/api/namespaces/Constants/enumerations/State.md index 230d59d..57f850d 100644 --- a/src/content/docs/api/namespaces/Constants/enumerations/State.md +++ b/src/content/docs/api/namespaces/Constants/enumerations/State.md @@ -9,9 +9,9 @@ title: "State" | Enumeration Member | Value | Defined in | | ------ | ------ | ------ | -| `CONNECTED` | `2` | [Constants.ts:7](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/Constants.ts#L7) | -| `CONNECTING` | `0` | [Constants.ts:5](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/Constants.ts#L5) | -| `DISCONNECTED` | `5` | [Constants.ts:10](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/Constants.ts#L10) | -| `DISCONNECTING` | `4` | [Constants.ts:9](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/Constants.ts#L9) | -| `NEARLY` | `1` | [Constants.ts:6](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/Constants.ts#L6) | -| `RECONNECTING` | `3` | [Constants.ts:8](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/Constants.ts#L8) | +| `CONNECTED` | `2` | [shoukaku/src/Constants.ts:7](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/Constants.ts#L7) | +| `CONNECTING` | `0` | [shoukaku/src/Constants.ts:5](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/Constants.ts#L5) | +| `DISCONNECTED` | `5` | [shoukaku/src/Constants.ts:10](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/Constants.ts#L10) | +| `DISCONNECTING` | `4` | [shoukaku/src/Constants.ts:9](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/Constants.ts#L9) | +| `NEARLY` | `1` | [shoukaku/src/Constants.ts:6](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/Constants.ts#L6) | +| `RECONNECTING` | `3` | [shoukaku/src/Constants.ts:8](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/Constants.ts#L8) | diff --git a/src/content/docs/api/namespaces/Constants/enumerations/Versions.md b/src/content/docs/api/namespaces/Constants/enumerations/Versions.md deleted file mode 100644 index a7c5dd0..0000000 --- a/src/content/docs/api/namespaces/Constants/enumerations/Versions.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -editUrl: false -next: false -prev: false -title: "Versions" ---- - -## Enumeration Members - -| Enumeration Member | Value | Defined in | -| ------ | ------ | ------ | -| `REST_VERSION` | `4` | [Constants.ts:28](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/Constants.ts#L28) | -| `WEBSOCKET_VERSION` | `4` | [Constants.ts:29](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/Constants.ts#L29) | diff --git a/src/content/docs/api/namespaces/Constants/enumerations/VoiceState.md b/src/content/docs/api/namespaces/Constants/enumerations/VoiceState.md index b41d6cd..4e92ff8 100644 --- a/src/content/docs/api/namespaces/Constants/enumerations/VoiceState.md +++ b/src/content/docs/api/namespaces/Constants/enumerations/VoiceState.md @@ -9,7 +9,7 @@ title: "VoiceState" | Enumeration Member | Value | Defined in | | ------ | ------ | ------ | -| `SESSION_ENDPOINT_MISSING` | `2` | [Constants.ts:16](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/Constants.ts#L16) | -| `SESSION_FAILED_UPDATE` | `3` | [Constants.ts:17](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/Constants.ts#L17) | -| `SESSION_ID_MISSING` | `1` | [Constants.ts:15](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/Constants.ts#L15) | -| `SESSION_READY` | `0` | [Constants.ts:14](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/Constants.ts#L14) | +| `SESSION_ENDPOINT_MISSING` | `2` | [shoukaku/src/Constants.ts:16](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/Constants.ts#L16) | +| `SESSION_FAILED_UPDATE` | `3` | [shoukaku/src/Constants.ts:17](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/Constants.ts#L17) | +| `SESSION_ID_MISSING` | `1` | [shoukaku/src/Constants.ts:15](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/Constants.ts#L15) | +| `SESSION_READY` | `0` | [shoukaku/src/Constants.ts:14](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/Constants.ts#L14) | diff --git a/src/content/docs/api/namespaces/Constants/variables/NodeDefaults.md b/src/content/docs/api/namespaces/Constants/variables/NodeDefaults.md index a0a1dc8..6d34d2c 100644 --- a/src/content/docs/api/namespaces/Constants/variables/NodeDefaults.md +++ b/src/content/docs/api/namespaces/Constants/variables/NodeDefaults.md @@ -11,4 +11,4 @@ const NodeDefaults: NodeOption; ## Defined in -[Constants.ts:49](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/Constants.ts#L49) +[shoukaku/src/Constants.ts:51](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/Constants.ts#L51) diff --git a/src/content/docs/api/namespaces/Constants/variables/ShoukakuClientInfo.md b/src/content/docs/api/namespaces/Constants/variables/ShoukakuClientInfo.md new file mode 100644 index 0000000..1f19080 --- /dev/null +++ b/src/content/docs/api/namespaces/Constants/variables/ShoukakuClientInfo.md @@ -0,0 +1,14 @@ +--- +editUrl: false +next: false +prev: false +title: "ShoukakuClientInfo" +--- + +```ts +const ShoukakuClientInfo: string; +``` + +## Defined in + +[shoukaku/src/Constants.ts:49](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/Constants.ts#L49) diff --git a/src/content/docs/api/namespaces/Constants/variables/ShoukakuDefaults.md b/src/content/docs/api/namespaces/Constants/variables/ShoukakuDefaults.md index ab3c90a..efc26be 100644 --- a/src/content/docs/api/namespaces/Constants/variables/ShoukakuDefaults.md +++ b/src/content/docs/api/namespaces/Constants/variables/ShoukakuDefaults.md @@ -11,4 +11,4 @@ const ShoukakuDefaults: Required; ## Defined in -[Constants.ts:32](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/Constants.ts#L32) +[shoukaku/src/Constants.ts:32](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/Constants.ts#L32) diff --git a/src/content/docs/api/namespaces/Constants/variables/Versions.md b/src/content/docs/api/namespaces/Constants/variables/Versions.md new file mode 100644 index 0000000..84605f2 --- /dev/null +++ b/src/content/docs/api/namespaces/Constants/variables/Versions.md @@ -0,0 +1,24 @@ +--- +editUrl: false +next: false +prev: false +title: "Versions" +--- + +```ts +const Versions: { + REST_VERSION: 4; + WEBSOCKET_VERSION: 4; +}; +``` + +## Type declaration + +| Name | Type | Default value | Defined in | +| ------ | ------ | ------ | ------ | +| `REST_VERSION` | `number` | 4 | [shoukaku/src/Constants.ts:28](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/Constants.ts#L28) | +| `WEBSOCKET_VERSION` | `number` | 4 | [shoukaku/src/Constants.ts:29](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/Constants.ts#L29) | + +## Defined in + +[shoukaku/src/Constants.ts:27](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/Constants.ts#L27) diff --git a/src/content/docs/api/namespaces/Utils/classes/TypedEventEmitter.md b/src/content/docs/api/namespaces/Utils/classes/TypedEventEmitter.md new file mode 100644 index 0000000..16d01ea --- /dev/null +++ b/src/content/docs/api/namespaces/Utils/classes/TypedEventEmitter.md @@ -0,0 +1,270 @@ +--- +editUrl: false +next: false +prev: false +title: "TypedEventEmitter" +--- + +## Extends + +- `EventEmitter` + +## Extended by + +- [`Player`](/api/classes/player/) +- [`Node`](/api/classes/node/) +- [`Shoukaku`](/api/classes/shoukaku/) + +## Type Parameters + +| Type Parameter | +| ------ | +| `T` *extends* `Record`\<`string`, `unknown`[]\> | + +## Methods + + + +### emit() + +```ts +emit(eventName: K, ...args: T[Extract]): boolean +``` + +Synchronously calls each of the listeners registered for the event named `eventName`, in the order they were registered, passing the supplied arguments +to each. + +Returns `true` if the event had listeners, `false` otherwise. + +```js +import { EventEmitter } from 'node:events'; +const myEmitter = new EventEmitter(); + +// First listener +myEmitter.on('event', function firstListener() { + console.log('Helloooo! first listener'); +}); +// Second listener +myEmitter.on('event', function secondListener(arg1, arg2) { + console.log(`event with parameters ${arg1}, ${arg2} in second listener`); +}); +// Third listener +myEmitter.on('event', function thirdListener(...args) { + const parameters = args.join(', '); + console.log(`event with parameters ${parameters} in third listener`); +}); + +console.log(myEmitter.listeners('event')); + +myEmitter.emit('event', 1, 2, 3, 4, 5); + +// Prints: +// [ +// [Function: firstListener], +// [Function: secondListener], +// [Function: thirdListener] +// ] +// Helloooo! first listener +// event with parameters 1, 2 in second listener +// event with parameters 1, 2, 3, 4, 5 in third listener +``` + +#### Type Parameters + +| Type Parameter | +| ------ | +| `K` *extends* `string` \| `symbol` | + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `eventName` | `K` | +| ...`args` | `T`\[`Extract`\<`K`, `string`\>\] | + +#### Returns + +`boolean` + +#### Overrides + +`EventEmitter.emit` + +#### Since + +v0.1.26 + +#### Defined in + +[shoukaku/src/Utils.ts:21](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/Utils.ts#L21) + +*** + + + +### off() + +```ts +off(eventName: K, listener: (...args: T[Extract]) => void): this +``` + +Alias for `emitter.removeListener()`. + +#### Type Parameters + +| Type Parameter | +| ------ | +| `K` *extends* `string` \| `symbol` | + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `eventName` | `K` | +| `listener` | (...`args`: `T`\[`Extract`\<`K`, `string`\>\]) => `void` | + +#### Returns + +`this` + +#### Overrides + +`EventEmitter.off` + +#### Since + +v10.0.0 + +#### Defined in + +[shoukaku/src/Utils.ts:17](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/Utils.ts#L17) + +*** + + + +### on() + +```ts +on(eventName: K, listener: (...args: T[Extract]) => void): this +``` + +Adds the `listener` function to the end of the listeners array for the event +named `eventName`. No checks are made to see if the `listener` has already +been added. Multiple calls passing the same combination of `eventName` and +`listener` will result in the `listener` being added, and called, multiple times. + +```js +server.on('connection', (stream) => { + console.log('someone connected!'); +}); +``` + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +By default, event listeners are invoked in the order they are added. The `emitter.prependListener()` method can be used as an alternative to add the +event listener to the beginning of the listeners array. + +```js +import { EventEmitter } from 'node:events'; +const myEE = new EventEmitter(); +myEE.on('foo', () => console.log('a')); +myEE.prependListener('foo', () => console.log('b')); +myEE.emit('foo'); +// Prints: +// b +// a +``` + +#### Type Parameters + +| Type Parameter | +| ------ | +| `K` *extends* `string` \| `symbol` | + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `eventName` | `K` | The name of the event. | +| `listener` | (...`args`: `T`\[`Extract`\<`K`, `string`\>\]) => `void` | The callback function | + +#### Returns + +`this` + +#### Overrides + +`EventEmitter.on` + +#### Since + +v0.1.101 + +#### Defined in + +[shoukaku/src/Utils.ts:9](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/Utils.ts#L9) + +*** + + + +### once() + +```ts +once(eventName: K, listener: (...args: T[Extract]) => void): this +``` + +Adds a **one-time** `listener` function for the event named `eventName`. The +next time `eventName` is triggered, this listener is removed and then invoked. + +```js +server.once('connection', (stream) => { + console.log('Ah, we have our first user!'); +}); +``` + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +By default, event listeners are invoked in the order they are added. The `emitter.prependOnceListener()` method can be used as an alternative to add the +event listener to the beginning of the listeners array. + +```js +import { EventEmitter } from 'node:events'; +const myEE = new EventEmitter(); +myEE.once('foo', () => console.log('a')); +myEE.prependOnceListener('foo', () => console.log('b')); +myEE.emit('foo'); +// Prints: +// b +// a +``` + +#### Type Parameters + +| Type Parameter | +| ------ | +| `K` *extends* `string` \| `symbol` | + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `eventName` | `K` | The name of the event. | +| `listener` | (...`args`: `T`\[`Extract`\<`K`, `string`\>\]) => `void` | The callback function | + +#### Returns + +`this` + +#### Overrides + +`EventEmitter.once` + +#### Since + +v0.3.0 + +#### Defined in + +[shoukaku/src/Utils.ts:13](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/Utils.ts#L13) diff --git a/src/content/docs/api/namespaces/Utils/functions/mergeDefault.md b/src/content/docs/api/namespaces/Utils/functions/mergeDefault.md index 2262fc7..72aaf1d 100644 --- a/src/content/docs/api/namespaces/Utils/functions/mergeDefault.md +++ b/src/content/docs/api/namespaces/Utils/functions/mergeDefault.md @@ -15,7 +15,7 @@ Merge the default options to user input | Type Parameter | | ------ | -| `T` *extends* \{\} | +| `T` *extends* `Record`\<`string`, `any`\> | ## Parameters @@ -32,4 +32,4 @@ Merged options ## Defined in -[Utils.ts:9](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/Utils.ts#L9) +[shoukaku/src/Utils.ts:35](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/Utils.ts#L35) diff --git a/src/content/docs/api/namespaces/Utils/functions/wait.md b/src/content/docs/api/namespaces/Utils/functions/wait.md index 3e58760..2bca0e2 100644 --- a/src/content/docs/api/namespaces/Utils/functions/wait.md +++ b/src/content/docs/api/namespaces/Utils/functions/wait.md @@ -25,4 +25,4 @@ A promise that resolves in x seconds ## Defined in -[Utils.ts:30](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/Utils.ts#L30) +[shoukaku/src/Utils.ts:56](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/Utils.ts#L56) diff --git a/src/content/docs/api/namespaces/Utils/type-aliases/Constructor.md b/src/content/docs/api/namespaces/Utils/type-aliases/Constructor.md index da630b1..8d38ea9 100644 --- a/src/content/docs/api/namespaces/Utils/type-aliases/Constructor.md +++ b/src/content/docs/api/namespaces/Utils/type-aliases/Constructor.md @@ -6,7 +6,7 @@ title: "Constructor" --- ```ts -type Constructor: (...args: any[]) => T; +type Constructor: (...args: unknown[]) => T; ``` ## Type Parameters @@ -19,7 +19,7 @@ type Constructor: (...args: any[]) => T; | Parameter | Type | | ------ | ------ | -| ...`args` | `any`[] | +| ...`args` | `unknown`[] | ## Returns @@ -27,4 +27,4 @@ type Constructor: (...args: any[]) => T; ## Defined in -[Utils.ts:1](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/Utils.ts#L1) +[shoukaku/src/Utils.ts:26](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/Utils.ts#L26) diff --git a/src/content/docs/api/type-aliases/LavalinkPlayerVoiceOptions.md b/src/content/docs/api/type-aliases/LavalinkPlayerVoiceOptions.md new file mode 100644 index 0000000..9eeebe2 --- /dev/null +++ b/src/content/docs/api/type-aliases/LavalinkPlayerVoiceOptions.md @@ -0,0 +1,14 @@ +--- +editUrl: false +next: false +prev: false +title: "LavalinkPlayerVoiceOptions" +--- + +```ts +type LavalinkPlayerVoiceOptions: Omit; +``` + +## Defined in + +[shoukaku/src/node/Rest.ts:107](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Rest.ts#L107) diff --git a/src/content/docs/api/type-aliases/LavalinkResponse.md b/src/content/docs/api/type-aliases/LavalinkResponse.md index 2cc361d..eba0f0d 100644 --- a/src/content/docs/api/type-aliases/LavalinkResponse.md +++ b/src/content/docs/api/type-aliases/LavalinkResponse.md @@ -16,4 +16,4 @@ type LavalinkResponse: ## Defined in -[node/Rest.ts:75](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Rest.ts#L75) +[shoukaku/src/node/Rest.ts:75](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Rest.ts#L75) diff --git a/src/content/docs/api/type-aliases/NodeEvents.md b/src/content/docs/api/type-aliases/NodeEvents.md new file mode 100644 index 0000000..ef66b35 --- /dev/null +++ b/src/content/docs/api/type-aliases/NodeEvents.md @@ -0,0 +1,14 @@ +--- +editUrl: false +next: false +prev: false +title: "NodeEvents" +--- + +```ts +type NodeEvents: { [K in keyof ShoukakuEvents]: ShoukakuEvents[K] extends [unknown, ...(infer R)] ? R : never }; +``` + +## Defined in + +[shoukaku/src/node/Node.ts:80](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Node.ts#L80) diff --git a/src/content/docs/api/type-aliases/NodeInfo.md b/src/content/docs/api/type-aliases/NodeInfo.md deleted file mode 100644 index ddcba92..0000000 --- a/src/content/docs/api/type-aliases/NodeInfo.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -editUrl: false -next: false -prev: false -title: "NodeInfo" ---- - -```ts -type NodeInfo: { - buildTime: number; - filters: string[]; - git: NodeInfoGit; - jvm: string; - lavaplayer: string; - plugins: NodeInfoPlugin[]; - sourceManagers: string[]; - version: NodeInfoVersion; -}; -``` - -## Type declaration - -| Name | Type | Defined in | -| ------ | ------ | ------ | -| `buildTime` | `number` | [node/Node.ts:61](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Node.ts#L61) | -| `filters` | `string`[] | [node/Node.ts:66](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Node.ts#L66) | -| `git` | [`NodeInfoGit`](/api/type-aliases/nodeinfogit/) | [node/Node.ts:62](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Node.ts#L62) | -| `jvm` | `string` | [node/Node.ts:63](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Node.ts#L63) | -| `lavaplayer` | `string` | [node/Node.ts:64](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Node.ts#L64) | -| `plugins` | [`NodeInfoPlugin`](/api/type-aliases/nodeinfoplugin/)[] | [node/Node.ts:67](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Node.ts#L67) | -| `sourceManagers` | `string`[] | [node/Node.ts:65](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Node.ts#L65) | -| `version` | [`NodeInfoVersion`](/api/type-aliases/nodeinfoversion/) | [node/Node.ts:60](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Node.ts#L60) | - -## Defined in - -[node/Node.ts:59](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Node.ts#L59) diff --git a/src/content/docs/api/type-aliases/NodeInfoGit.md b/src/content/docs/api/type-aliases/NodeInfoGit.md deleted file mode 100644 index 20bb364..0000000 --- a/src/content/docs/api/type-aliases/NodeInfoGit.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -editUrl: false -next: false -prev: false -title: "NodeInfoGit" ---- - -```ts -type NodeInfoGit: { - branch: string; - commit: string; - commitTime: number; -}; -``` - -## Type declaration - -| Name | Type | Defined in | -| ------ | ------ | ------ | -| `branch` | `string` | [node/Node.ts:49](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Node.ts#L49) | -| `commit` | `string` | [node/Node.ts:50](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Node.ts#L50) | -| `commitTime` | `number` | [node/Node.ts:51](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Node.ts#L51) | - -## Defined in - -[node/Node.ts:48](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Node.ts#L48) diff --git a/src/content/docs/api/type-aliases/NodeInfoPlugin.md b/src/content/docs/api/type-aliases/NodeInfoPlugin.md deleted file mode 100644 index d730ecc..0000000 --- a/src/content/docs/api/type-aliases/NodeInfoPlugin.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -editUrl: false -next: false -prev: false -title: "NodeInfoPlugin" ---- - -```ts -type NodeInfoPlugin: { - name: string; - version: string; -}; -``` - -## Type declaration - -| Name | Type | Defined in | -| ------ | ------ | ------ | -| `name` | `string` | [node/Node.ts:55](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Node.ts#L55) | -| `version` | `string` | [node/Node.ts:56](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Node.ts#L56) | - -## Defined in - -[node/Node.ts:54](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Node.ts#L54) diff --git a/src/content/docs/api/type-aliases/NodeInfoVersion.md b/src/content/docs/api/type-aliases/NodeInfoVersion.md deleted file mode 100644 index 84a89e0..0000000 --- a/src/content/docs/api/type-aliases/NodeInfoVersion.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -editUrl: false -next: false -prev: false -title: "NodeInfoVersion" ---- - -```ts -type NodeInfoVersion: { - build: string; - major: number; - minor: number; - patch: number; - preRelease: string; - semver: string; -}; -``` - -## Type declaration - -| Name | Type | Defined in | -| ------ | ------ | ------ | -| `build` | `string` | [node/Node.ts:45](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Node.ts#L45) | -| `major` | `number` | [node/Node.ts:41](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Node.ts#L41) | -| `minor` | `number` | [node/Node.ts:42](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Node.ts#L42) | -| `patch` | `number` | [node/Node.ts:43](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Node.ts#L43) | -| `preRelease` | `string` | [node/Node.ts:44](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Node.ts#L44) | -| `semver` | `string` | [node/Node.ts:40](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Node.ts#L40) | - -## Defined in - -[node/Node.ts:39](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Node.ts#L39) diff --git a/src/content/docs/api/type-aliases/NonResumableHeaders.md b/src/content/docs/api/type-aliases/NonResumableHeaders.md new file mode 100644 index 0000000..4d36e10 --- /dev/null +++ b/src/content/docs/api/type-aliases/NonResumableHeaders.md @@ -0,0 +1,14 @@ +--- +editUrl: false +next: false +prev: false +title: "NonResumableHeaders" +--- + +```ts +type NonResumableHeaders: Omit; +``` + +## Defined in + +[shoukaku/src/node/Node.ts:78](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Node.ts#L78) diff --git a/src/content/docs/api/type-aliases/PlayOptions.md b/src/content/docs/api/type-aliases/PlayOptions.md index df18e7e..c03c73e 100644 --- a/src/content/docs/api/type-aliases/PlayOptions.md +++ b/src/content/docs/api/type-aliases/PlayOptions.md @@ -11,4 +11,4 @@ type PlayOptions: Omit; ## Defined in -[guild/Player.ts:8](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L8) +[shoukaku/src/guild/Player.ts:8](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L8) diff --git a/src/content/docs/api/type-aliases/PlayerEvents.md b/src/content/docs/api/type-aliases/PlayerEvents.md new file mode 100644 index 0000000..8dc71b0 --- /dev/null +++ b/src/content/docs/api/type-aliases/PlayerEvents.md @@ -0,0 +1,34 @@ +--- +editUrl: false +next: false +prev: false +title: "PlayerEvents" +--- + +```ts +type PlayerEvents: { + closed: [WebSocketClosedEvent]; + end: [TrackEndEvent]; + exception: [TrackExceptionEvent]; + resumed: [Player]; + start: [TrackStartEvent]; + stuck: [TrackStuckEvent]; + update: [PlayerUpdate]; +}; +``` + +## Type declaration + +| Name | Type | Description | Defined in | +| ------ | ------ | ------ | ------ | +| `closed` | [[`WebSocketClosedEvent`](/api/interfaces/websocketclosedevent/)] | Emitted when the current websocket connection is closed | [shoukaku/src/guild/Player.ts:144](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L144) | +| `end` | [[`TrackEndEvent`](/api/interfaces/trackendevent/)] | Emitted when the current playing track ends | [shoukaku/src/guild/Player.ts:134](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L134) | +| `exception` | [[`TrackExceptionEvent`](/api/interfaces/trackexceptionevent/)] | Emitted when there is an error caused by the current playing track | [shoukaku/src/guild/Player.ts:154](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L154) | +| `resumed` | [[`Player`](/api/classes/player/)] | Emitted when the library manages to resume the player | [shoukaku/src/guild/Player.ts:159](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L159) | +| `start` | [[`TrackStartEvent`](/api/interfaces/trackstartevent/)] | Emitted when a new track starts | [shoukaku/src/guild/Player.ts:149](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L149) | +| `stuck` | [[`TrackStuckEvent`](/api/interfaces/trackstuckevent/)] | Emitted when the current playing track gets stuck due to an error | [shoukaku/src/guild/Player.ts:139](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L139) | +| `update` | [[`PlayerUpdate`](/api/interfaces/playerupdate/)] | Emitted when a playerUpdate even is received from Lavalink | [shoukaku/src/guild/Player.ts:164](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L164) | + +## Defined in + +[shoukaku/src/guild/Player.ts:129](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L129) diff --git a/src/content/docs/api/type-aliases/ResumeOptions.md b/src/content/docs/api/type-aliases/ResumeOptions.md index 587db55..62a8208 100644 --- a/src/content/docs/api/type-aliases/ResumeOptions.md +++ b/src/content/docs/api/type-aliases/ResumeOptions.md @@ -11,4 +11,4 @@ type ResumeOptions: Omit; ## Defined in -[guild/Player.ts:9](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L9) +[shoukaku/src/guild/Player.ts:9](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L9) diff --git a/src/content/docs/api/type-aliases/Severity.md b/src/content/docs/api/type-aliases/Severity.md index 56071e9..20517ea 100644 --- a/src/content/docs/api/type-aliases/Severity.md +++ b/src/content/docs/api/type-aliases/Severity.md @@ -11,4 +11,4 @@ type Severity: "common" | "suspicious" | "fault"; ## Defined in -[node/Rest.ts:6](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/node/Rest.ts#L6) +[shoukaku/src/node/Rest.ts:6](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/node/Rest.ts#L6) diff --git a/src/content/docs/api/type-aliases/ShoukakuEvents.md b/src/content/docs/api/type-aliases/ShoukakuEvents.md new file mode 100644 index 0000000..7d1b6c7 --- /dev/null +++ b/src/content/docs/api/type-aliases/ShoukakuEvents.md @@ -0,0 +1,34 @@ +--- +editUrl: false +next: false +prev: false +title: "ShoukakuEvents" +--- + +```ts +type ShoukakuEvents: { + close: [string, number, string]; + debug: [string, string]; + disconnect: [string, number]; + error: [string, Error]; + raw: [string, unknown]; + ready: [string, boolean]; + reconnecting: [string, number, number]; +}; +``` + +## Type declaration + +| Name | Type | Description | Defined in | +| ------ | ------ | ------ | ------ | +| `close` | [`string`, `number`, `string`] | Emitted when a websocket connection to Lavalink closes | [shoukaku/src/Shoukaku.ts:126](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/Shoukaku.ts#L126) | +| `debug` | [`string`, `string`] | Emitted when data useful for debugging is produced | [shoukaku/src/Shoukaku.ts:111](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/Shoukaku.ts#L111) | +| `disconnect` | [`string`, `number`] | Emitted when a websocket connection to Lavalink disconnects | [shoukaku/src/Shoukaku.ts:131](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/Shoukaku.ts#L131) | +| `error` | [`string`, `Error`] | Emitted when an error occurs | [shoukaku/src/Shoukaku.ts:116](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/Shoukaku.ts#L116) | +| `raw` | [`string`, `unknown`] | Emitted when a raw message is received from Lavalink | [shoukaku/src/Shoukaku.ts:136](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/Shoukaku.ts#L136) | +| `ready` | [`string`, `boolean`] | Emitted when Shoukaku is ready to receive operations | [shoukaku/src/Shoukaku.ts:121](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/Shoukaku.ts#L121) | +| `reconnecting` | [`string`, `number`, `number`] | Emitted when reconnect tries are occurring and how many tries are left | [shoukaku/src/Shoukaku.ts:106](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/Shoukaku.ts#L106) | + +## Defined in + +[shoukaku/src/Shoukaku.ts:101](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/Shoukaku.ts#L101) diff --git a/src/content/docs/api/type-aliases/TrackEndReason.md b/src/content/docs/api/type-aliases/TrackEndReason.md index 8d7d580..bd1c1f9 100644 --- a/src/content/docs/api/type-aliases/TrackEndReason.md +++ b/src/content/docs/api/type-aliases/TrackEndReason.md @@ -16,4 +16,4 @@ type TrackEndReason: ## Defined in -[guild/Player.ts:7](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/guild/Player.ts#L7) +[shoukaku/src/guild/Player.ts:7](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/guild/Player.ts#L7) diff --git a/src/content/docs/api/variables/AllowedPackets.md b/src/content/docs/api/variables/AllowedPackets.md index 6436e76..26bf692 100644 --- a/src/content/docs/api/variables/AllowedPackets.md +++ b/src/content/docs/api/variables/AllowedPackets.md @@ -11,4 +11,4 @@ const AllowedPackets: string[]; ## Defined in -[connectors/Connector.ts:10](https://github.com/shipgirlproject/shoukaku/blob/428f92c432a1875d1770e54c312147a1f47a448d/src/connectors/Connector.ts#L10) +[shoukaku/src/connectors/Connector.ts:12](https://github.com/shipgirlproject/shoukaku/blob/049b5dc536f3b28e41c5423a707d8a02ac9377a7/src/connectors/Connector.ts#L12)