Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
yt-api - npm Package Compare versions
Comparing version 0.1.2 to 0.1.3
| { | ||
| "name": "yt-api", | ||
| "version": "0.1.2", | ||
| "description": "", | ||
| "version": "0.1.3", | ||
| "description": "A light weight, easy, and super fast way of interacting with the YouTube Data API v3.", | ||
| "main": "src/index.js", | ||
@@ -10,4 +10,4 @@ "types": "typings/index.d.ts", | ||
| }, | ||
| "author": "", | ||
| "license": "ISC", | ||
| "author": "Ice", | ||
| "license": "MIT", | ||
| "dependencies": { | ||
@@ -14,0 +14,0 @@ "snekfetch": "^3.6.4", |
220
README.md
@@ -1,12 +0,10 @@ | ||
| # Welcome to the yt-api a light weight and easy to use api. | ||
| # Welcome to the yt-api a light weight, easy, and super fast way of interacting with the YouTube Data API v3. | ||
| Installing is as simple as using | ||
| `npm i yt-api` | ||
| # Setup | ||
| To use the api you need a api key from google and you can get that [here](https://console.developers.google.com) | ||
| Once you have created the api key you need to enable the `Youtube Data API v3` by clicking on the libraries tab and clicking on the `Youtube Data API v3` then click on enable and your done! | ||
| # Using the api | ||
| Once you have created the api key you need to enable the `Youtube Data API v3` by clicking on the libraries tab and clicking on the `Youtube Data API v3` then click on enable and your almost done! | ||
| # Defining the api | ||
| ```javascript | ||
| const api = require("yt-api"); | ||
| const api = require("yt-api").api; | ||
| const API = new api("PASTE_API_KEY_HERE"); | ||
@@ -17,204 +15,26 @@ ``` | ||
| ```javascript | ||
| API.getVideoInfo("YOUTUBE_VIDEO_ID" /*Needs to be a valid video id or it will throw a error!*/, info => { | ||
| console.log("This video's title is "+info.title+" with a id of "+info.videoID+"."); | ||
| }); | ||
| API.getVideoByID("mj9KRKSvdbk" /*This must be a valid video id or else it will reject the promise*/).then(i => { | ||
| console.log("Here is the url: "+i.url); | ||
| }).catch(e => console.error(e)); | ||
| //Results for the getVideoInfo | ||
| videoID: //the video's id, | ||
| url: //the url to the video, | ||
| title: //The video title | ||
| channel: { | ||
| id: //The channel id | ||
| user: //The user, | ||
| url: //The video's channel url | ||
| }, | ||
| livestream: //Is it a livestream?, | ||
| category: //The categoryId that the videos in, | ||
| thumbnail: //The videos thumbnail, | ||
| description: //The video's description, | ||
| publishDate: //The date it was published at, | ||
| duration: { | ||
| days: //The durration in days | ||
| hours: //The durration in hours, | ||
| minutes: //The durration in minutes, | ||
| seconds: //The durration in seconds | ||
| }, | ||
| statistics: { | ||
| views: //The total views the video has, | ||
| likes: //The total likes the video has, | ||
| dislikes: //The total dislikes the video has, | ||
| comments: //The total commends the video has, | ||
| favorites: //The people who favorited the video | ||
| } | ||
| //Returns Promise<VideoInfo> | ||
| ``` | ||
| # Searching youtube | ||
| # Searching for a video | ||
| ```javascript | ||
| API.searchYouTube("Alan walker faded" /*If there are 0 results it will log to the console that it found no results*/, info => { | ||
| console.log(`The video's title is ${info.title} and its id is ${info.videoID}`); | ||
| }); | ||
| API.searchForVideo("H.A.Y ncs").then(i => { | ||
| console.log("Here is the url: "+i.url); | ||
| }).catch(e => console.error(e)); | ||
| /*Results that you can use for the callback function. | ||
| NOTE: You can use the getVideoInfo function to get more info about this search*/ | ||
| videoID: //The video's unique id, | ||
| url: //the video's url, | ||
| title: //the Video's title, | ||
| channel: { | ||
| id: //The channel id, | ||
| user: //The user, | ||
| url: //The video's channel url | ||
| }, | ||
| thumbnail: //The videos thumbnail, | ||
| //Returns Promise<SearchedVideoInfo> | ||
| /*NOTE: You can use the getVideoByID function to get more info about this video*/ | ||
| ``` | ||
| # Getting more than 1 video result aka the searchVideos function | ||
| # Searching for multiple videos | ||
| ```javascript | ||
| API.searchVideos("Marshmello alone", 5 /*The amount of videos you want to be searched or the limit*/, videos => { | ||
| //Mapping the videos | ||
| let sidenum=0; | ||
| console.log(videos.map(v=>`the video's title is ${v.title} and the id is ${v.videoID}`).join("\n")); | ||
| //Getting a specific video | ||
| let video = videos[/*number in between 0 and the ammount you specified in this case its 5*/]; | ||
| console.log(`This videos title is ${video.title} and the id is ${video.videoID}`); | ||
| }); | ||
| API.searchForVideos("H.A.Y ncs").then(i => { | ||
| console.log("Here is the first result's video url "+i[0].url) | ||
| }).catch(e => console.error(e)); | ||
| //Returns | ||
| videoID: //The video's unique id, | ||
| url: //the video's url, | ||
| title: //the Video's title, | ||
| channel: { | ||
| id: //The channel id, | ||
| user: //The user, | ||
| url: //The video's channel url | ||
| }, | ||
| thumbnail: //The videos thumbnail, | ||
| ``` | ||
| # Discord music bot example. | ||
| ###### Ever wanted to make a music bot with a song selection well now you can using this code and this is the full code no cuts no unpasted code its all the same code minus the np and queue command wich i hope you can figure out your self's. | ||
| ```javascript | ||
| const { Client } = require("discord.js"); | ||
| const bot = new Client(); | ||
| const ytdl = require("ytdl-core"); | ||
| //The api to get song info and user input. | ||
| let YouTube = require("./index.js"); | ||
| let yt = new YouTube("API_KEY_HERE"); | ||
| //The queue's | ||
| let guilds = {}; | ||
| bot.login("BOT_TOKEN_HERE"); | ||
| bot.on("ready", () => console.log("REEADY!")); | ||
| bot.on("message", msg => { | ||
| let prefix = ';'; | ||
| let args = msg.content.slice(prefix.length).trim().split(" "); | ||
| let cmd = args.shift().toLowerCase(); | ||
| let guild = guilds[msg.guild.id]; | ||
| if(cmd === "play") { | ||
| if(!guild) guild = guilds[msg.guild.id] = { | ||
| queue: [], | ||
| isPlaying: false | ||
| }; | ||
| if(!msg.member.voiceChannel) return msg.channel.send("You must be in a voice channel first!"); | ||
| let song = args.join(" "); | ||
| if(!song) return msg.channel.send("You need to provide a searchterm!"); | ||
| if(guild.isPlaying) { | ||
| yt.searchVideos(song, 5, async videos => { | ||
| try { | ||
| let num=0; | ||
| let m = await msg.channel.send(` | ||
| **Song selection:** | ||
| ${videos.map(v=>`**${++num}:** ${v.title}`).join("\n")} | ||
| Please provide a value between 1 and 5. | ||
| `); | ||
| let collector = await msg.channel.awaitMessages(m=>m.content > 0 && m.content < 6 && m.author.id === msg.author.id && m.channel.id === msg.channel.id, { | ||
| maxMatches: 1, | ||
| time: 10000, | ||
| errors: ['time'] | ||
| }); | ||
| let selection = parseInt(collector.first().content); | ||
| let vid = videos[selection - 1]; | ||
| m.delete(5000); | ||
| yt.getVideoInfo(vid.videoID, i => { | ||
| guild.queue.push({ | ||
| title: i.title, | ||
| id: i.videoID, | ||
| url: i.url, | ||
| duration: { | ||
| days: i.duration.days, | ||
| hours: i.duration.hours, | ||
| minutes: i.duration.minutes, | ||
| seconds: i.duration.seconds | ||
| } | ||
| }); | ||
| return msg.channel.send(`Added **${i.title}** to the queue!`); | ||
| }); | ||
| } catch (error) { | ||
| return msg.channel.send("No value was entered. Canceling video selection!"); | ||
| } | ||
| }); | ||
| } else { | ||
| guild.isPlaying = true; | ||
| yt.searchVideos(song, 5, async videos => { | ||
| try { | ||
| let num=0; | ||
| let m = await msg.channel.send(` | ||
| **Song selection:** | ||
| ${videos.map(v=>`**${++num}:** ${v.title}`).join("\n")} | ||
| Please provide a value between 1 and 5. | ||
| `); | ||
| let collector = await msg.channel.awaitMessages(m=>m.content > 0 && m.content < 6 && m.author.id === msg.author.id && m.channel.id === msg.channel.id, { | ||
| maxMatches: 1, | ||
| time: 10000, | ||
| errors: ['time'] | ||
| }); | ||
| let selection = parseInt(collector.first().content); | ||
| let vid = videos[selection - 1]; | ||
| m.delete(5000); | ||
| yt.getVideoInfo(vid.videoID, i => { | ||
| guild.queue.push({ | ||
| title: i.title, | ||
| id: i.videoID, | ||
| url: i.url, | ||
| duration: { | ||
| days: i.duration.days, | ||
| hours: i.duration.hours, | ||
| minutes: i.duration.minutes, | ||
| seconds: i.duration.seconds | ||
| } | ||
| }); | ||
| return playSong(i.url, guild, msg); | ||
| }); | ||
| } catch (error) { | ||
| return msg.channel.send("No value was entered. Canceling video selection!"); | ||
| } | ||
| }); | ||
| } | ||
| } | ||
| }); | ||
| function playSong(url, guild, msg) { | ||
| let vc = msg.member.voiceChannel; | ||
| vc.join().then(con => { | ||
| let dispatcher = con.playStream(ytdl(url, { filter: "audioonly" })); | ||
| dispatcher.on("end", () => { | ||
| guild.queue.shift(); | ||
| if(guild.queue.length === 0) { | ||
| vc.leave(); | ||
| delete guilds[msg.guild.id]; | ||
| } else { | ||
| playSong(guild.queue[0].url, guild, msg); | ||
| } | ||
| }); | ||
| }); | ||
| msg.channel.send(`Now playing: **${guild.queue[0].title}** (${guild.queue[0].duration.hours}${guild.queue[0].duration.minutes}${guild.queue[0].duration.seconds})`); | ||
| } | ||
| //Returns Promise<SearchedVideoInfo> as a array | ||
| ``` |
@@ -9,3 +9,3 @@ const snekfetch = require("snekfetch"); | ||
| async getVideo(id) { | ||
| async getVideoByID(id) { | ||
| return new Promise(async (res, rej) => { | ||
@@ -52,3 +52,3 @@ let apiResponse = await snekfetch.get(`https://www.googleapis.com/youtube/v3/videos?part=snippet,statistics,liveStreamingDetails,contentDetails&id=${id}&key=${this.key}`); | ||
| async getVideo(search) { | ||
| async searchForVideo(search) { | ||
| return new Promise(async (res, rej) => { | ||
@@ -74,3 +74,3 @@ let apiResponse = await snekfetch.get(`https://www.googleapis.com/youtube/v3/search?part=id,snippet&q=${encodeURIComponent(search)}&type=video&key=${this.key}`); | ||
| async getVideos(search, maxResults) { | ||
| async searchForVideos(search, maxResults) { | ||
| return new Promise(async (res, rej) => { | ||
@@ -77,0 +77,0 @@ let apiResponse = await snekfetch.get(`https://www.googleapis.com/youtube/v3/search?part=id,snippet&q=${encodeURIComponent(search)}&type=video&maxResults=${maxResults}&key=${this.key}`); |
@@ -1,10 +0,10 @@ | ||
| const API = require("../src/index.js"); | ||
| const api = require("../src/index.js"); | ||
| declare module "yt-api" { | ||
| export class API<string> { | ||
| export class api<string> { | ||
| public constructor(ytKey: string); | ||
| public getVideoByID(id: string): Promise<VideoInfo>; | ||
| public getVideo(search: string): Promise<SearchedVideoInfo>; | ||
| public getVideos(search: string, maxResults: number): Promise<Array<SearchedVideoInfo>>; | ||
| public searchForVideo(search: string): Promise<SearchedVideoInfo>; | ||
| public searchForVideos(search: string, maxResults: number): Promise<Array<SearchedVideoInfo>>; | ||
| } | ||
@@ -11,0 +11,0 @@ |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
No contributors or author data
MaintenancePackage does not specify a list of contributors or an author in package.json.
Found 1 instance in 1 package
Improved metrics
- Number of low maintenance alerts
- decreased by-33.33%
2
Worsened metrics
- Total package byte prevSize
- decreased by-44.53%
8554
- Number of lines in readme file
- decreased by-82.19%
39
No dependency changes