Coder Social home page Coder Social logo

node-ytsr's Introduction

NPM version NPM downloads Dependencies Dependencies

NPM info

node-ytsr

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

Usage

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

ytsr.getFilters('github', function(err, filters) {
  if(err) throw err;
  filter = filters.get('Type').find(o => o.name === 'Video');
  ytsr.getFilters(filter.ref, function(err, filters) {
    if(err) throw err;
    filter = filters.get('Duration').find(o => o.name.startsWith('Short'));
    var options = {
      limit: 5,
      nextpageRef: filter.ref,
    }
    ytsr(null, options, function(err, searchResults) {
      if(err) throw err;
      dosth(searchResults);
    });
  });
});

API

ytsr(searchString, [options, callback])

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
    • nextpageRef[String] -> if u wanna continue a previous search or use filters
  • callback(err, result)

    • function
    • getting fired after the request is done
    • contains an error or a result
  • returns a Promise when no callback is defined

  • Example response

ytsr.getFilters(searchString, [callback])

Pulls avaible filters for the given string/ref

  • searchString

    • string to search for
    • or previously optained filter ref
  • callback(err, result)

    • function
    • getting fired after the request is done
    • contains an error or a result
  • returns a Promise when no callback is defined

  • Example response

Related / Works well with

Install

npm install --save ytsr

License

MIT

node-ytsr's People

Contributors

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

Stargazers

 avatar  avatar

Watchers

 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.