diff --git a/docs/classes/QueueManager.html b/docs/classes/QueueManager.html index 2cf716d..6cbaafe 100644 --- a/docs/classes/QueueManager.html +++ b/docs/classes/QueueManager.html @@ -150,7 +150,7 @@
The youtube search result
A RegExp instance to identify youtube playlist url
A RegExp instance to identify youtube video url
Static AUDIO_ERROR
Static AUDIO_START
Static QUEUE_END
Static QUEUE_START
Readonly audioManager
audiodeleteHandler
getHandler
soundcloudSearch
Returns Promise-
@@ -401,7 +401,7 @@
@@ -70,6 +70,14 @@
youtubeSearch
-- youtube
Search(options: youtubeSearchOptions): Promise<youtubeSearchResult>
+ - youtube
Search(options: youtubeSearchOptions): Promise<youtubeSearchResult<youtubeSearchResultType>>
options: Returns Promise<youtubeSearchResult> +
Returns Promise<youtubeSearchResult<youtubeSearchResultType>>
The youtube search result
@@ -526,9 +526,12 @@Returns Promise-
youtube
SearchOptions
- -
+
-
youtube
SearchResult
+ -
+ youtube
VideoType
+
-
Audio
ManagerResolvable
@@ -544,6 +547,12 @@
Returns Promise-
youtube
SearchResultType
+ -
+ PLAYLIST_
URL
+
+ -
+ VIDEO_
URL
+
-
version
diff --git a/docs/interfaces/QueueManagerEvents.html b/docs/interfaces/QueueManagerEvents.html
index 6600a81..96522c8 100644
--- a/docs/interfaces/QueueManagerEvents.html
+++ b/docs/interfaces/QueueManagerEvents.html
@@ -101,7 +101,7 @@ audioEnd: (guildID: string, urlOrLocation: string) => void
@@ -151,7 +151,7 @@ audioError: (guildID: string, urlOrLocation: string, errorCode: ErrorCode) => void
@@ -207,7 +207,7 @@ audioStart: (guildID: string, urlOrLocation: string) => void
@@ -264,7 +264,7 @@ -
-
- -
+
-
youtube
SearchResult
+ -
+ youtube
VideoType
+
-
Audio
ManagerResolvable
@@ -426,6 +429,12 @@
@@ -132,7 +132,7 @@ setLimit: number
@@ -235,9 +235,12 @@ -
youtube
SearchOptions
- -
+
-
youtube
SearchResult
+ -
+ youtube
VideoType
+
-
Audio
ManagerResolvable
@@ -253,6 +256,12 @@ -
youtube
SearchResultType
+ -
+ PLAYLIST_
URL
+
+ -
+ VIDEO_
URL
+
-
version
diff --git a/docs/interfaces/soundcloudSearchResult.html b/docs/interfaces/soundcloudSearchResult.html
index 54aac76..7fda14e 100644
--- a/docs/interfaces/soundcloudSearchResult.html
+++ b/docs/interfaces/soundcloudSearchResult.html
@@ -100,7 +100,7 @@ tracks: Track<TrackInfo>[]
@@ -110,7 +110,7 @@ type: soundcloudSearchResultType
@@ -207,9 +207,12 @@ -
youtube
SearchOptions
- -
+
-
youtube
SearchResult
+ -
+ youtube
VideoType
+
-
Audio
ManagerResolvable
@@ -225,6 +228,12 @@ -
youtube
SearchResultType
+ -
+ PLAYLIST_
URL
+
+ -
+ VIDEO_
URL
+
-
version
diff --git a/docs/interfaces/youtubeSearchOptions.html b/docs/interfaces/youtubeSearchOptions.html
index 6427327..0ea534f 100644
--- a/docs/interfaces/youtubeSearchOptions.html
+++ b/docs/interfaces/youtubeSearchOptions.html
@@ -85,9 +85,8 @@
@@ -96,12 +95,12 @@
-
- playlistLimit: number
+
+ fullPlaylist: boolean
@@ -111,17 +110,7 @@ query: string
-
-
-
- searchLimit: number
-
@@ -209,21 +198,21 @@ SearchOptions
-
- playlist
Limit
+ fullPlaylist
-
query
- -
- search
Limit
-
audioEnd
audioError
audioStart
queueEnd
Parameters
@@ -290,7 +290,7 @@queueStart
Parameters
@@ -408,9 +408,12 @@Returns void youtubeSearchOptions
Returns void youtubeSearchResultType
+ -
+ PLAYLIST_
URL
+
+ -
+ VIDEO_
URL
+
-
version
diff --git a/docs/interfaces/soundcloudSearchOptions.html b/docs/interfaces/soundcloudSearchOptions.html
index 28ae34e..0bdcf25 100644
--- a/docs/interfaces/soundcloudSearchOptions.html
+++ b/docs/interfaces/soundcloudSearchOptions.html
@@ -102,7 +102,7 @@ query: string
@@ -112,7 +112,7 @@ searchLimit: number
@@ -122,7 +122,7 @@ Offset: number
query
Optional searchLimit
Optional searchOffset
searchOptional setLimit
Optional setLimit
Optional setLimit
tracks
type
type
type
Index
Properties
-- playlist
Limit
+ - full
Playlist
- query
- - search
Limit
Properties
Properties
Optional playlistLimit
-Optional fullPlaylist
+query
Optional searchLimit
-Optional searchLimit
youtube--
+
-
youtube
SearchResult
+ -
+ youtube
VideoType
+
-
Audio
ManagerResolvable
@@ -239,6 +228,12 @@ -
youtube
SearchResultType
+ -
+ PLAYLIST_
URL
+
+ -
+ VIDEO_
URL
+
-
version
diff --git a/docs/interfaces/youtubeSearchResult.html b/docs/interfaces/youtubeSearchResult.html
index 3fef3f8..9f592ce 100644
--- a/docs/interfaces/youtubeSearchResult.html
+++ b/docs/interfaces/youtubeSearchResult.html
@@ -56,7 +56,7 @@
youtubeSearchResult
-Optional searchLimit
Interface youtubeSearchResult
+Interface youtubeSearchResult<T>
Interface youtubeSearchResult
Type parameters
++-
+
+
+T: youtubeSearchResultType
+Hierarchy
@@ -97,20 +105,20 @@
tracks: Track<Video>[]
+ tracks: Track<youtubeVideoType[T]>[]
type: youtubeSearchResultType
+ type: T
@@ -197,7 +205,7 @@
Properties
tracks
-type
-type
--
+
-
youtube
SearchResult
-
@@ -210,6 +218,9 @@
@@ -114,6 +115,8 @@
@@ -128,7 +131,7 @@ AudioManagerResolvable: AudioManager | AudioManagerOptions
@@ -143,7 +146,7 @@ soundcloudMetadata: SCDLTrackInfo
@@ -158,7 +161,7 @@ soundcloudSearchResultType: "track" | "set" | "search"
@@ -170,10 +173,10 @@
youtubeMetadata: YoutubeSRVideo
+ youtubeMetadata: PlaylistVideo | YoutubeSearchVideoInfo | YoutubeVideoDetails
@@ -188,7 +191,7 @@ youtubeSearchResultType: "video" | "playlist" | "search"
@@ -200,6 +203,36 @@
+
+ PLAYLIST_URL: RegExp = ...
+
+
+
+
+
+
+
+
+ VIDEO_URL: RegExp = ...
+
+
+
+
+
+
-
youtube
SearchOptions
- -
+
-
youtube
SearchResult
+ -
+ youtube
VideoType
+
-
Audio
ManagerResolvable
@@ -323,6 +359,12 @@ -
youtube
SearchResultType
+ -
+ PLAYLIST_
URL
+
+ -
+ VIDEO_
URL
+
-
version
diff --git a/docs/modules/ValidationUtil.QueueManagerValidation.html b/docs/modules/ValidationUtil.QueueManagerValidation.html
index 928cecb..b447e02 100644
--- a/docs/modules/ValidationUtil.QueueManagerValidation.html
+++ b/docs/modules/ValidationUtil.QueueManagerValidation.html
@@ -140,7 +140,7 @@ -
type
+-
+ youtube
VideoType
+
-
Audio
ManagerResolvable
@@ -225,6 +236,12 @@ -
youtube
SearchResultType
+ -
+ PLAYLIST_
URL
+
+ -
+ VIDEO_
URL
+
-
version
diff --git a/docs/interfaces/youtubeVideoType.html b/docs/interfaces/youtubeVideoType.html
index 0289d45..3cdb9b9 100644
--- a/docs/interfaces/youtubeVideoType.html
+++ b/docs/interfaces/youtubeVideoType.html
@@ -101,7 +101,7 @@ playlist: PlaylistVideo
@@ -111,7 +111,7 @@ search: YoutubeSearchVideoInfo
@@ -121,7 +121,7 @@ video: YoutubeVideoDetails
diff --git a/docs/modules.html b/docs/modules.html
index 182b570..a79f51c 100644
--- a/docs/modules.html
+++ b/docs/modules.html
@@ -98,7 +98,8 @@ - soundcloud
SearchOptions
- soundcloud
SearchResult
- youtube
SearchOptions
- - youtube
SearchResult
+ - youtube
SearchResult
+ - youtube
VideoType
type
playlist
search
video
Interfaces
Type aliases
Variables
+- PLAYLIST_
URL
+ - VIDEO_
URL
- version
AudioManagerResolvable
soundcloudMetadata
soundcloudSearchResultType
soundcloudSearchResultType
youtubeMetadata
-youtubeSearchResultType
youtubeSearchResultType
Variables
+Const PLAYLIST_URL
+A RegExp instance to identify youtube playlist url
+Const VIDEO_URL
+A RegExp instance to identify youtube video url
+Const version
@@ -305,9 +338,12 @@Const version
Const version
validateSoundcloudSearchOptions
Parameters