diff --git a/classes/PipedAPI.html b/classes/PipedAPI.html index 3404775..5ba70cf 100644 --- a/classes/PipedAPI.html +++ b/classes/PipedAPI.html @@ -20,7 +20,7 @@ +
  • Defined in piped-api.ts:14
    • @@ -62,14 +62,14 @@
    host: string = "https://pipedapi.kavin.rocks"

    Returns PipedAPI

    +
  • Defined in piped-api.ts:16

    • Properties

    host

    host: string
    +
  • Defined in piped-api.ts:15

    • Methods

    @@ -93,7 +93,7 @@
    +
  • Defined in piped-api.ts:26

    • channel

    +
  • Defined in piped-api.ts:71

    • channelByName

    +
  • Defined in piped-api.ts:86

    • comments

    +
  • Defined in piped-api.ts:58

    • playlist

    +
  • Defined in piped-api.ts:107

    • search

    +
  • Defined in piped-api.ts:149

    • sponsors

    +
  • Defined in piped-api.ts:133

    • streams

    +
  • Defined in piped-api.ts:47

    • suggestions

    +
  • Defined in piped-api.ts:122

    • trending

    +
  • Defined in piped-api.ts:37

    • user

    +
  • Defined in piped-api.ts:96
    • diff --git a/index.html b/index.html index 50db212..a612310 100644 --- a/index.html +++ b/index.html @@ -13,6 +13,7 @@

    piped-api

    Piped API

    This is the API wrapper for Piped in Node.js (Typescript).

    +

    Docs

    Installation

    npm i piped-api

    Usage

    import { PipedAPI } from "piped-api";

    const api = new PipedAPI("https://ytapi.dc09.ru");

    let trending = await api.trending("US");

    console.log(trending[0].title);
diff --git a/interfaces/Types.AudioStream.html b/interfaces/Types.AudioStream.html
index 8b77503..7072cda 100644
--- a/interfaces/Types.AudioStream.html
+++ b/interfaces/Types.AudioStream.html
@@ -21,7 +21,7 @@
 
      
 
    • AudioStream
    
+
  • Defined in responses.interface.ts:24
    • 
 
    
 
    
 
    
@@ -47,57 +47,57 @@
 
    bitrate
    
 
    bitrate: number
    
+
  • Defined in responses.interface.ts:25
    • 
 
    
 
    codec
    
 
    codec: string
    
+
  • Defined in responses.interface.ts:26
    • 
 
    
 
    format
    
 
    format: string
    
+
  • Defined in responses.interface.ts:27
    • 
 
    
 
    indexEnd
    
 
    indexEnd: number
    
+
  • Defined in responses.interface.ts:28
    • 
 
    
 
    indexStart
    
 
    indexStart: number
    
+
  • Defined in responses.interface.ts:29
    • 
 
    
 
    initEnd
    
 
    initEnd: number
    
+
  • Defined in responses.interface.ts:31
    • 
 
    
 
    initStart
    
 
    initStart: number
    
+
  • Defined in responses.interface.ts:30
    • 
 
    
 
    mimeType
    
 
    mimeType: string
    
+
  • Defined in responses.interface.ts:32
    • 
 
    
 
    quality
    
 
    quality: string
    
+
  • Defined in responses.interface.ts:33
    • 
 
    
 
    url
    
 
    url: string
    
+
  • Defined in responses.interface.ts:34
    • 
 
    
 
    videoOnly
    
 
    videoOnly: boolean
    +
  • Defined in responses.interface.ts:35
    • diff --git a/interfaces/Types.Channel.html b/interfaces/Types.Channel.html index 92164a6..0118b42 100644 --- a/interfaces/Types.Channel.html +++ b/interfaces/Types.Channel.html @@ -21,7 +21,7 @@
    • Channel
    +
  • Defined in responses.interface.ts:99
    • @@ -46,52 +46,52 @@

    avatarUrl

    avatarUrl: string
    +
  • Defined in responses.interface.ts:100

    • bannerUrl

    bannerUrl: string
    +
  • Defined in responses.interface.ts:101

    • description

    description: string
    +
  • Defined in responses.interface.ts:102

    • id

    id: string
    +
  • Defined in responses.interface.ts:103

    • name

    name: string
    +
  • Defined in responses.interface.ts:104

    • nextpage

    nextpage: string
    +
  • Defined in responses.interface.ts:105

    • relatedStreams

    relatedStreams: Video[]
    +
  • Defined in responses.interface.ts:106

    • subscriberCount

    subscriberCount: number
    +
  • Defined in responses.interface.ts:107

    • Optional type

    type?: string
    +
  • Defined in responses.interface.ts:109

    • verified

    verified: boolean
    +
  • Defined in responses.interface.ts:108
    • diff --git a/interfaces/Types.Comment.html b/interfaces/Types.Comment.html index a4c6a2e..8dc5396 100644 --- a/interfaces/Types.Comment.html +++ b/interfaces/Types.Comment.html @@ -21,7 +21,7 @@
    • Comment
    +
  • Defined in responses.interface.ts:69
    • @@ -46,52 +46,52 @@

    author

    author: string
    +
  • Defined in responses.interface.ts:70

    • commentId

    commentId: string
    +
  • Defined in responses.interface.ts:71

    • commentText

    commentText: string
    +
  • Defined in responses.interface.ts:72

    • commentedTime

    commentedTime: string
    +
  • Defined in responses.interface.ts:73

    • commentorUrl

    commentorUrl: string
    +
  • Defined in responses.interface.ts:74

    • hearted

    hearted: boolean
    +
  • Defined in responses.interface.ts:75

    • likeCount

    likeCount: number
    +
  • Defined in responses.interface.ts:76

    • pinned

    pinned: boolean
    +
  • Defined in responses.interface.ts:77

    • thumbnail

    thumbnail: string
    +
  • Defined in responses.interface.ts:78

    • verified

    verified: boolean
    +
  • Defined in responses.interface.ts:79
    • diff --git a/interfaces/Types.Comments.html b/interfaces/Types.Comments.html index b1d83b2..4e1be38 100644 --- a/interfaces/Types.Comments.html +++ b/interfaces/Types.Comments.html @@ -21,7 +21,7 @@
    • Comments
    +
  • Defined in responses.interface.ts:63
    • @@ -39,17 +39,17 @@

    comments

    comments: Comment[]
    +
  • Defined in responses.interface.ts:64

    • disabled

    disabled: boolean
    +
  • Defined in responses.interface.ts:65

    • nextpage

    nextpage: string
    +
  • Defined in responses.interface.ts:66
    • diff --git a/interfaces/Types.NextPageChannel.html b/interfaces/Types.NextPageChannel.html index 802991c..1bcb52e 100644 --- a/interfaces/Types.NextPageChannel.html +++ b/interfaces/Types.NextPageChannel.html @@ -21,7 +21,7 @@
    • NextPageChannel
    +
  • Defined in responses.interface.ts:112
    • @@ -38,12 +38,12 @@

    nextpage

    nextpage: string
    +
  • Defined in responses.interface.ts:113

    • relatedStreams

    relatedStreams: Video[]
    +
  • Defined in responses.interface.ts:114
    • diff --git a/interfaces/Types.NextPagePlaylist.html b/interfaces/Types.NextPagePlaylist.html index c433dd5..b61bc4a 100644 --- a/interfaces/Types.NextPagePlaylist.html +++ b/interfaces/Types.NextPagePlaylist.html @@ -21,7 +21,7 @@
    • NextPagePlaylist
    +
  • Defined in responses.interface.ts:129
    • @@ -38,12 +38,12 @@

    nextpage

    nextpage: string
    +
  • Defined in responses.interface.ts:130

    • relatedStreams

    relatedStreams: Video[]
    +
  • Defined in responses.interface.ts:131
    • diff --git a/interfaces/Types.Playlist.html b/interfaces/Types.Playlist.html index 3e0b883..87b7c76 100644 --- a/interfaces/Types.Playlist.html +++ b/interfaces/Types.Playlist.html @@ -21,7 +21,7 @@
    • Playlist
    +
  • Defined in responses.interface.ts:117
    • @@ -45,47 +45,47 @@

    bannerUrl

    bannerUrl: string
    +
  • Defined in responses.interface.ts:118

    • name

    name: string
    +
  • Defined in responses.interface.ts:119

    • nextpage

    nextpage: string
    +
  • Defined in responses.interface.ts:120

    • relatedStreams

    relatedStreams: Video[]
    +
  • Defined in responses.interface.ts:121

    • thumbnailUrl

    thumbnailUrl: string
    +
  • Defined in responses.interface.ts:122

    • uploader

    uploader: string
    +
  • Defined in responses.interface.ts:123

    • uploaderAvatar

    uploaderAvatar: string
    +
  • Defined in responses.interface.ts:124

    • uploaderUrl

    uploaderUrl: string
    +
  • Defined in responses.interface.ts:125

    • videos

    videos: number
    +
  • Defined in responses.interface.ts:126
    • diff --git a/interfaces/Types.Search.html b/interfaces/Types.Search.html index 4fb229a..23f58b9 100644 --- a/interfaces/Types.Search.html +++ b/interfaces/Types.Search.html @@ -21,7 +21,7 @@
    • Search
    +
  • Defined in responses.interface.ts:148
    • @@ -40,22 +40,22 @@

    corrected

    corrected: boolean
    +
  • Defined in responses.interface.ts:151

    • items

    items: (Video | Channel)[]
    +
  • Defined in responses.interface.ts:150

    • nextpage

    nextpage: string
    +
  • Defined in responses.interface.ts:149

    • suggestion

    suggestion: null | string
    +
  • Defined in responses.interface.ts:152
    • diff --git a/interfaces/Types.Segments.html b/interfaces/Types.Segments.html index f3ae249..983cc3f 100644 --- a/interfaces/Types.Segments.html +++ b/interfaces/Types.Segments.html @@ -21,7 +21,7 @@
    • Segments
    +
  • Defined in responses.interface.ts:140
    • @@ -41,27 +41,27 @@

    UUID

    UUID: string
    +
  • Defined in responses.interface.ts:141

    • actionType

    actionType: string
    +
  • Defined in responses.interface.ts:142

    • category

    category: string
    +
  • Defined in responses.interface.ts:143

    • segment

    segment: string
    +
  • Defined in responses.interface.ts:144

    • videoDuration

    videoDuration: number
    +
  • Defined in responses.interface.ts:145
    • diff --git a/interfaces/Types.Sponsors.html b/interfaces/Types.Sponsors.html index 3f4be39..a4e5c73 100644 --- a/interfaces/Types.Sponsors.html +++ b/interfaces/Types.Sponsors.html @@ -21,7 +21,7 @@
    • Sponsors
    +
  • Defined in responses.interface.ts:134
    • @@ -39,17 +39,17 @@

    hash

    hash: string
    +
  • Defined in responses.interface.ts:135

    • segments

    segments: Segments[]
    +
  • Defined in responses.interface.ts:136

    • videoId

    videoId: string
    +
  • Defined in responses.interface.ts:137
    • diff --git a/interfaces/Types.Streams.html b/interfaces/Types.Streams.html index 5e873ac..1cf56b6 100644 --- a/interfaces/Types.Streams.html +++ b/interfaces/Types.Streams.html @@ -21,7 +21,7 @@
    • Streams
    +
  • Defined in responses.interface.ts:1
    • @@ -56,102 +56,102 @@

    audioStreams

    audioStreams: AudioStream[]
    +
  • Defined in responses.interface.ts:2

    • dash

    dash: null | string
    +
  • Defined in responses.interface.ts:3

    • description

    description: string
    +
  • Defined in responses.interface.ts:4

    • dislikes

    dislikes: number
    +
  • Defined in responses.interface.ts:5

    • duration

    duration: number
    +
  • Defined in responses.interface.ts:6

    • hls

    hls: null | string
    +
  • Defined in responses.interface.ts:7

    • lbryId

    lbryId: string
    +
  • Defined in responses.interface.ts:8

    • likes

    likes: number
    +
  • Defined in responses.interface.ts:9

    • livestream

    livestream: boolean
    +
  • Defined in responses.interface.ts:10

    • proxyUrl

    proxyUrl: string
    +
  • Defined in responses.interface.ts:11

    • relatedStreams

    relatedStreams: Video[]
    +
  • Defined in responses.interface.ts:12

    • subtitles

    subtitles: Subtitle[]
    +
  • Defined in responses.interface.ts:13

    • thumbnailUrl

    thumbnailUrl: string
    +
  • Defined in responses.interface.ts:14

    • title

    title: string
    +
  • Defined in responses.interface.ts:15

    • uploadedDate

    uploadedDate: string
    +
  • Defined in responses.interface.ts:16

    • uploader

    uploader: string
    +
  • Defined in responses.interface.ts:17

    • uploaderUrl

    uploaderUrl: string
    +
  • Defined in responses.interface.ts:18

    • uploaderVerified

    uploaderVerified: boolean
    +
  • Defined in responses.interface.ts:19

    • videoStreams

    videoStreams: VideoStream[]
    +
  • Defined in responses.interface.ts:20

    • views

    views: number
    +
  • Defined in responses.interface.ts:21
    • diff --git a/interfaces/Types.Subtitle.html b/interfaces/Types.Subtitle.html index c9bb4df..79ed7f6 100644 --- a/interfaces/Types.Subtitle.html +++ b/interfaces/Types.Subtitle.html @@ -21,7 +21,7 @@
    • Subtitle
    +
  • Defined in responses.interface.ts:38
    • @@ -41,27 +41,27 @@

    autoGenerated

    autoGenerated: boolean
    +
  • Defined in responses.interface.ts:39

    • code

    code: string
    +
  • Defined in responses.interface.ts:40

    • mimeType

    mimeType: string
    +
  • Defined in responses.interface.ts:41

    • name

    name: string
    +
  • Defined in responses.interface.ts:42

    • url

    url: string
    +
  • Defined in responses.interface.ts:43
    • diff --git a/interfaces/Types.Video.html b/interfaces/Types.Video.html index 9191ddb..a1d246a 100644 --- a/interfaces/Types.Video.html +++ b/interfaces/Types.Video.html @@ -21,7 +21,7 @@
    • Video
    +
  • Defined in responses.interface.ts:82
    • @@ -50,72 +50,72 @@

    duration

    duration: number
    +
  • Defined in responses.interface.ts:83

    • isShort

    isShort: boolean
    +
  • Defined in responses.interface.ts:93

    • shortDescription

    shortDescription: string
    +
  • Defined in responses.interface.ts:95

    • thumbnail

    thumbnail: string
    +
  • Defined in responses.interface.ts:84

    • title

    title: string
    +
  • Defined in responses.interface.ts:85

    • Optional type

    type?: string
    +
  • Defined in responses.interface.ts:96

    • uploaded

    uploaded: number
    +
  • Defined in responses.interface.ts:94

    • uploadedDate

    uploadedDate: string
    +
  • Defined in responses.interface.ts:86

    • uploaderAvatar

    uploaderAvatar: string
    +
  • Defined in responses.interface.ts:87

    • uploaderName

    uploaderName: string
    +
  • Defined in responses.interface.ts:90

    • uploaderUrl

    uploaderUrl: string
    +
  • Defined in responses.interface.ts:88

    • uploaderVerified

    uploaderVerified: boolean
    +
  • Defined in responses.interface.ts:89

    • url

    url: string
    +
  • Defined in responses.interface.ts:91

    • views

    views: number
    +
  • Defined in responses.interface.ts:92
    • diff --git a/interfaces/Types.VideoStream.html b/interfaces/Types.VideoStream.html index 2ccd375..af7533d 100644 --- a/interfaces/Types.VideoStream.html +++ b/interfaces/Types.VideoStream.html @@ -21,7 +21,7 @@
    • VideoStream
    +
  • Defined in responses.interface.ts:46
    • @@ -50,72 +50,72 @@

    bitrate

    bitrate: number
    +
  • Defined in responses.interface.ts:47

    • codec

    codec: string
    +
  • Defined in responses.interface.ts:48

    • format

    format: string
    +
  • Defined in responses.interface.ts:49

    • fps

    fps: number
    +
  • Defined in responses.interface.ts:50

    • height

    height: number
    +
  • Defined in responses.interface.ts:51

    • indexEnd

    indexEnd: number
    +
  • Defined in responses.interface.ts:52

    • indexStart

    indexStart: number
    +
  • Defined in responses.interface.ts:53

    • initEnd

    initEnd: number
    +
  • Defined in responses.interface.ts:55

    • initStart

    initStart: number
    +
  • Defined in responses.interface.ts:54

    • mimeType

    mimeType: string
    +
  • Defined in responses.interface.ts:56

    • quality

    quality: string
    +
  • Defined in responses.interface.ts:57

    • url

    url: string
    +
  • Defined in responses.interface.ts:58

    • videoOnly

    videoOnly: boolean
    +
  • Defined in responses.interface.ts:59

    • width

    width: number
    +
  • Defined in responses.interface.ts:60
    • diff --git a/modules/Types.html b/modules/Types.html index eaf2f84..eca5311 100644 --- a/modules/Types.html +++ b/modules/Types.html @@ -16,7 +16,7 @@
  • Types

    • Namespace Types

    +
  • Defined in responses.interface.ts:1

    • Index