@dogonis/vtube-client v1.0.6

Hi there

This is a client for Astroner/vtube-b. This package provides response types and VTubeClient class as a simple abstraction over axios to fetch data

Install

npm i @dogonis/vtube-client

yarn add @dogonis/vtube-client

Table of content

• Basic Usage
• API
  • Channel
  • Artist
  • Video
  • Search
  • User
  • Session

Basic Usage

import { VTubeClient } from "@dogonis/vtube-client"

const client = new VTubeClient("https://backend.address.com/");

export const fetchImagineDragons = () => {
    return client.search.queryMusic("Imagine Dragons");
}

API

Basically VTubeClient provides a collection of public APIs to fetch data:

• channel - youtube channel info
• artist - music artist info
• video - media info i.e. formats, descriptions and e.t.c
• search - query data from youtube or music
• user - provides methods to create/restore session for private API

Channel

• info - get channel info
• videos - get channel videos. Has continuation interface to get the next page

Artist

• get - get artist info

Video

• formats - get media formats
• info - get media info
• srcURL - generates src url for the video. itag param specifies file format, can be obtain from formats

Search

• queryYoutube - query data from youtube
• queryMusic - query data from music

User

• signIn - request API token for provided credentials, returns session
• signUp - registers user with provided data
• restoreSession - creates session with provided token

Session

• getToken - session token
• userInfo - get session user info
• getDynamicPlaylist - requests dynamic playlist
• userPlaylists - get session user's playlists
• userSubscriptions - get session user's subscriptions
• recommendations
  • music - get session user's music recommendations
  • youtube - get session user's youtube recommendations