npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

recordrtc.org

v1.0.6

Published

http://recordrtc.org/ is a documentation webpage for RecordRTC.js. It is open-sourced in github and everyone can collaborate to improve documentation.

Downloads

5

Readme

RecordRTC.org

npm downloads

http://recordrtc.org/ is a documentation webpage for RecordRTC.js. It is open-sourced in github and everyone can collaborate to improve documentation.

To contribute:

  1. You should modify RecordRTC.js file (aka latest.js file)
  2. You'll see that each function/property/method is having comments (format is chosen from http://usejsdoc.org/).
  3. Using jsdoc tool, you can generate documentation HTML pages from latest.js file
  4. You should NEVER modify HTML pages. You merely need to modify latest.js file for documentation.

Steps to contribute:

  1. Modify latest.js file
  2. Use below NPM-commands to generate HTML pages.
  3. Manually copy/paste latest.js file in the resulting recordrtc.org directory
  4. Copy recordrtc.org directory and replace in RecordRTC github clone's gh-pages section
  5. Send a pull-request and done!
# First step: install recordrtc.org template and javascript file
npm install recordrtc.org

# Second step: generate HTML files from template & latest.js file
cd node_modules && cd recordrtc.org

# This command generates HTML pages from latest.js file

# for Linux/Mac
node_modules/.bin/jsdoc node_modules/recordrtc/RecordRTC.js -d ./../../recordrtc-gh-pages node_modules/recordrtc/README.md -t template

# for Windows
node_modules\.bin\jsdoc node_modules\recordrtc\RecordRTC.js -d .\..\..\recordrtc-gh-pages node_modules\recordrtc\README.md -t template

Now you'll see a directory with name recordrtc.org.

# This command runs index.html file
# You can use it to preview HTML pages (doc files)

# for Linux/mac
./../../recordrtc.org/index.html

# for Windows
.\..\..\recordrtc.org\index.html

Send pull requests

Now, you should fork this repository:

And push/pull recordrtc.org directory to gh-pages.

How to modify latest.js file?

RecordRTC is using comments format from jsdoc:

E.g.

/**
* Description
* @summary Summary
* @typedef Hello
* @example
* var some = new Something();
*/

Example - stopRecording method:

/**
 * This method stops recording. It takes single "callback" argument. It is suggested to get blob or URI in the callback to make sure all encoders finished their jobs.
 * @param {function} callback - This callback function is invoked after completion of all encoding jobs.
 * @method
 * @memberof RecordRTC
 * @instance
 * @example
 * recordRTC.stopRecording(function(videoURL) {
 *     video.src = videoURL;
 * });
 * @todo Implement <code class="str">recordRTC.stopRecording().getDataURL(callback);</code>
 */
stopRecording: stopRecording,

License

RecordRTC.js is released under MIT licence . Copyright (c) Muaz Khan.