rtc-core - npm Package Compare versions

Comparing version 3.0.0 to 3.1.0

detect.js

@@ -10,3 +10,3 @@ /* jshint node: true */
 /**
-  ## rtc-core/detect
+  ### `rtc-core/detect`
 
@@ -13,0 +13,0 @@ A browser detection helper for accessing prefix-free versions of the various

index.js

@@ -6,8 +6,8 @@ /* jshint node: true */
 /**
-# rtc-core
+  # rtc-core
 
-The rtc-core package includes a number of core types and constants that
-are used across the rtc.io suite.
+  The rtc-core package includes a number of core types and constants that
+  are used across the rtc.io suite.
 **/
 
-exports.detect = require('./detect');
+exports.detect = require('./detect');

package.json

 {
   "name": "rtc-core",
   "description": "Core definitions and functions for the rtc.io suite",
-  "version": "3.0.0",
+  "version": "3.1.0",
   "dependencies": {
@@ -9,2 +9,3 @@ "detect-browser": "^1.0.0"
   "devDependencies": {
+    "peerpair": "^1.0.0",
     "tape": "^2",
@@ -11,0 +12,0 @@ "zuul": "^1"

README.md

@@ -9,6 +9,5 @@ # rtc-core
 
-[![Build Status](https://img.shields.io/travis/rtc-io/rtc-core.svg?branch=master)](https://travis-ci.org/rtc-io/rtc-core)
-![unstable](https://img.shields.io/badge/stability-unstable-yellowgreen.svg)
+[![Build Status](https://img.shields.io/travis/rtc-io/rtc-core.svg?branch=master)](https://travis-ci.org/rtc-io/rtc-core) [![unstable](https://img.shields.io/badge/stability-unstable-yellowgreen.svg)](https://github.com/dominictarr/stability#unstable) 
 
-## rtc-core/detect
+### `rtc-core/detect`
 
@@ -32,38 +31,16 @@ A browser detection helper for accessing prefix-free versions of the various
 
-## rtc-core/match
+### `rtc-core/reset`
 
-```
-match(browser, spec?, fn?) ==> Boolean
-```
+This is a simple, cross-browser method for resetting a media element
+back to a initial state after having media attached.
 
-The `match` helper is useful for customizing the behaviour of your WebRTC
-application based on browser environment and also specific versions of
-the browser (using a [semver](http://semver.org/) based spec).
+### `rtc-core/wait-connected`
 
-```js
-var detect = require('rtc-core/detect');
-var match = require('rtc-core/match');
+`waitConnected(pc, callback)`
 
-if (match('chrome', '>= 35')) {
-  console.log('matched >= chrome 35, actual version: ' + detect.version);
-}
-else if (match('chrome', '32 - 34')) {
-  console.log('matched chrome 32 - 34, actual version: ' + detect.version);
-}
-else if (match('chrome', '^31')) {
-  console.log('matched chrome 31, actual version: ' + detect.version)
-}
-else if (match('chrome')) {
-  console.log('matched chrome (any version), actual version: ' + detect.version);
-}
-else {
-  console.log('not running chrome, browser: ' + detect.browser + ', version: ' + detect.version);
-}
-```
+A simple helper function that will monitor `iceconnectionstatechange` events
+and wait until a connected `iceConnectionState` has been triggered (either
+`connected` or `completed`).  Once this state has been achieved the event
+listener will be removed and a callback fired.
 
-## rtc-core/reset
-
-This is a simple, cross-browser method for resetting a media element
-back to a initial state after having media attached.
-
 ## License(s)
@@ -70,0 +47,0 @@

reset.js

@@ -5,3 +5,3 @@ /* jshint node: true */
 /**
-  ## rtc-core/reset
+  ### `rtc-core/reset`
 
@@ -28,2 +28,2 @@ This is a simple, cross-browser method for resetting a media element
   return el;
-};
+};

test/all.js

 require('./detect');
 require('./detect-browser');
 require('./plugin');
+require('./wait-connected');

New alerts

License Policy Violation

License

This 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

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

23138

increased by4.04%

Number of package files

22

increased by10%

Lines of code

229

increased by19.27%

Worsened metrics

Dev dependency count

3

increased by50%

Number of lines in readme file

61

decreased by-27.38%

No dependency changes