Code Monkey home page Code Monkey logo

videojs-qs's Introduction

videojs-qs

A wrapper for the Node querystring module mimic provided by rollup-plugin-node-builtins for Video.js-based players.

Note: Does not support the querystring.escape or querystring.unescape properties.

Installation

npm install --save videojs-qs

API

There are two ways to use this module/plugin to retrieve a querystring-ish object. There is no particular advantage or disadvantage to one or the other - use whichever makes the most sense in your use-case.

videojs.qs() Method

Including this module will add the qs method to the videojs namespace. This is a function that returns a clone of the Node querystring built-in module.

var qs = videojs.qs().parse(window.location.search.substr(1));

qs Plugin

In addition to the videojs.qs() method, a plugin is added that registers a qs() method on every player instance. This method behaves identically to the videojs.qs() method.

var qs = player.qs().parse(window.location.search.substr(1));

querystring-ish Objects

The objects returned by the aforementioned API methods have the following methods available:

stringify()

The general usage of this is to turn an object into a query string:

qs.stringify({foo: 'bar', bop: [1, 2]}); // "foo=bar&bop=1&bop=2"

Note: This is also aliased as encode().

parse()

The general usage of this is to turn a query string into an object:

qs.parse('foo=bar&bop=1&bop=2'); // {foo: 'bar', bop: [1, 2]}

Note: This is also aliased as decode().

search

This property does not come from the Rollup plugin!

The search property is provided by videojs-qs as a convenient way to reach a pre-parseed copy of the window.location.search value in the current page context.

For example, if window.location.search is ?foo=bar&bop=1&bop=2, the search property will look like: {foo: 'bar', bop: [1, 2]}.

License

Apache-2.0. Copyright (c) Brightcove, Inc.

videojs-qs's People

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Forkers

isabella232

videojs-qs's Issues

Action required: Greenkeeper could not be activated 🚨

🚨 You need to enable Continuous Integration on all branches of this repository. 🚨

To enable Greenkeeper, you need to make sure that a commit status is reported on all branches. This is required by Greenkeeper because we are using your CI build statuses to figure out when to notify you about breaking changes.

Since we did not receive a CI status on the greenkeeper/initial branch, we assume that you still need to configure it.

If you have already set up a CI for this repository, you might need to check your configuration. Make sure it will run on all new branches. If you don’t want it to run on every branch, you can whitelist branches starting with greenkeeper/.

We recommend using Travis CI, but Greenkeeper will work with every other CI service as well.

Action required: Greenkeeper could not be activated 🚨

🚨 You need to enable Continuous Integration on all branches of this repository. 🚨

To enable Greenkeeper, you need to make sure that a commit status is reported on all branches. This is required by Greenkeeper because it uses your CI build statuses to figure out when to notify you about breaking changes.

Since we didn’t receive a CI status on the greenkeeper/initial branch, it’s possible that you don’t have CI set up yet. We recommend using Travis CI, but Greenkeeper will work with every other CI service as well.

If you have already set up a CI for this repository, you might need to check how it’s configured. Make sure it is set to run on all new branches. If you don’t want it to run on absolutely every branch, you can whitelist branches starting with greenkeeper/.

Once you have installed and configured CI on this repository correctly, you’ll need to re-trigger Greenkeeper’s initial pull request. To do this, please delete the greenkeeper/initial branch in this repository, and then remove and re-add this repository to the Greenkeeper App’s white list on Github. You'll find this list on your repo or organization’s settings page, under Installed GitHub Apps.

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.