docs: add example urls for route

pionxzh · Oct 21, 2023 · b4168eb · b4168eb
1 parent 3f9546f
commit b4168eb
Showing 1 changed file with 24 additions and 1 deletion.
diff --git a/src/apis/route.ts b/src/apis/route.ts
@@ -7,6 +7,9 @@ import type { AlbumSearchOptions, AutoCompleteOptions, GifSearchOptions, Pornsta
 import type { PornstarListOptions, VideoListOptions } from '../types/ListOptions'
 
 export const Route = {
+    /**
+     * @url https://www.pornhub.com/
+     */
     mainPage() {
         return `${BASE_URL}/`
     },
@@ -37,25 +40,42 @@ export const Route = {
             alt: 0,
         })
     },
-
+    /**
+     * @url https://www.pornhub.com/album/7529441
+     */
     albumPage(id: string) {
         return urlcat(BASE_URL, '/album/:id', { id })
     },
+    /**
+     * @url https://www.pornhub.com/photo/833578021
+     */
     photoPage(id: string) {
         return urlcat(BASE_URL, '/photo/:id', { id })
     },
     videoPage(id: string) {
         return urlcat(BASE_URL, '/view_video.php', { viewkey: id })
     },
+    /**
+     * @url https://www.pornhub.com/pornstar/eva-elfie
+     */
     pornstarPage(name: string) {
         return urlcat(BASE_URL, '/pornstar/:name', { name })
     },
+    /**
+     * @url https://www.pornhub.com/model/luna-okko
+     */
     modelPage(name: string) {
         return urlcat(BASE_URL, '/model/:name', { name })
     },
+    /**
+     * @url https://www.pornhub.com/model/luna-okko/videos
+     */
     modelVideosPage(name: string, page: number) {
         return urlcat(BASE_URL, '/model/:name/videos', { name, page })
     },
+    /**
+     * @url https://www.pornhub.com/channels/brazzers
+     */
     channelPage(name: string) {
         return urlcat(BASE_URL, '/channels/:name', { name })
     },
@@ -65,6 +85,9 @@ export const Route = {
     randomPage() {
         return urlcat(BASE_URL, '/random')
     },
+    /**
+     * @url https://www.pornhub.com/recommended
+     */
     recommendedPage({
         order = 'Most Relevant',
         page = 1,