Giter Club home page Giter Club logo

node-ytsr's Introduction

node-ytsr

NPM version NPM downloads codecov Known Vulnerabilities Discord

NPM info

Simple js only module to search YouTube Doesn't need any login or GoogleAPI key

Support

You can contact us for support on our chat server

Usage

const ytsr = require('ytsr');
let filter;

ytsr.getFilters('github').then(async filters1 => {
  filter1 = filters.get('Type').find(o => o.name === 'Video');
  const filters2 = await ytsr.getFilters(filter.ref);
  filter2 = filters2.get('Duration').find(o => o.name.startsWith('Short'));
  const options = {
    limit: 5,
    nextpageRef: filter2.ref,
  }
  const searchResults = await ytsr(null, options);
  dosth(searchResults);
}).catch(err => {
  console.error(err);
});

API

ytsr(searchString, [options])

Searches for the given string

  • searchString
    • string to search for
  • options
    • object with options
    • possible settings:
    • safeSearch[Boolean] -> pull items in youtube restriction mode.
    • limit[integer] -> limits the pulled items, defaults to 100, set to Infinity to get the whole playlist - numbers <1 result in the default being used
    • nextpageRef[String] -> if u wanna continue a previous search or use filters
    • All additional parameters will get passed to miniget, which is used to do the https requests
  • returns a Promise
  • Example response

ytsr.getFilters(searchString, options)

Pulls avaible filters for the given string/ref

  • searchString
    • string to search for
    • or previously optained filter ref
  • options
    • request options passed to miniget
  • returns a Promise
  • Example response

Related / Works well with

Install

npm install --save ytsr

License

MIT

node-ytsr's People

Contributors

androz2091 avatar catsmiaow avatar cbrown350 avatar greenkeeper[bot] avatar khoohaoyit avatar mattez02 avatar ovyerus avatar pyroignus avatar ragzouken avatar timeforaninja avatar venkataramanab avatar

Stargazers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.