embedjs - npm Package Compare versions

Comparing version 0.0.2 to 0.0.3

lib/embedjs.js

@@ -15,2 +15,3 @@ var urlExtractor = require('url-extractor');
   options.height = options.height || '400';
+  options.autoplay = 'autoplay' in options ? options.autoplay : true;
 
@@ -83,3 +84,5 @@ var urls = this.getUrls(text);
 SteemEmbed.youtube = function (url, id, options) {
-  return '<iframe width="' + options.width + '" height="' + options.height + '" src="//www.youtube.com/embed/' + id + '" frameborder="0" scrolling="no" allowfullscreen></iframe>';
+  var autoplayValue = options.autoplay ? 1 : 0;
+  var srcUrl = '//www.youtube.com/embed/' + id + '?autoplay=' + autoplayValue;
+  return '<iframe width="' + options.width + '" height="' + options.height + '" src="' + srcUrl + '" frameborder="0" scrolling="no" allowfullscreen></iframe>';
 };
@@ -86,0 +89,0 @@

package.json

 {
   "name": "embedjs",
-  "version": "0.0.2",
-  "description": "",
+  "version": "0.0.3",
+  "description": "Extract embed information for all the media links in your texts",
   "main": "index.js",
@@ -15,3 +15,8 @@ "scripts": {
     "embed",
-    "embedjs"
+    "embedjs",
+    "youtube",
+    "vimeo",
+    "periscope",
+    "twitch",
+    "soundcloud"
   ],
@@ -28,4 +33,5 @@ "author": "AdCpm <[e-mail]> (https://github.com/adcpm)",
   "contributors": [
-    "Fabien (https://github.com/adcpm)"
+    "Fabien (https://github.com/adcpm)",
+    "Pooria (https://github.com/p0o)"
   ]
 }

README.md

 # Embed.js
 
-Extract embeds from a string.
+With EmbedJS you can simply extract all the media links in your content and get the embed information of them in a JavaScript collection format. You can use these informations to append video embeds however you need in your app.
 
+
+Simple usage:
+
+```javascript
+import embedjs from 'embedjs';
+
+const text = 'Lorem ipsum dolor sit amet https://www.twitch.tv/johnnydarko420, consectetur adipiscing elit, https://soundcloud.com/liluzivert/do-what-i-want-produced-by-maaly-raw-don-cannon sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in https://www.youtube.com/watch?v=waiCd_CVxdc reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, https://www.google.fr/?gws_rd=ssl sunt in culpa qui officia deserunt mollit anim id est laborum.';
+const embeds = embedjs.getAll(text);
+
+console.log(embeds);
 ```
-var embedjs = require('embedjs');
-var text = 'Lorem ipsum dolor sit amet https://www.twitch.tv/johnnydarko420, consectetur adipiscing elit, https://soundcloud.com/liluzivert/do-what-i-want-produced-by-maaly-raw-don-cannon sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in https://www.youtube.com/watch?v=waiCd_CVxdc reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, https://www.google.fr/?gws_rd=ssl sunt in culpa qui officia deserunt mollit anim id est laborum.';
-var embeds = embedjs.getAll(text);
-console.log(embeds);
-```
+
+Which you would get a result like this:
+
+```javascript
+[ { type: 'video',
+    url: 'https://www.twitch.tv/johnnydarko420',
+    provider_name: 'Twitch',
+    id: 'johnnydarko420',
+    embed: '<iframe width="100" height="120" src="//player.twitch.tv/?channel=johnnydarko420&autoplay=false" frameborder="0" scrolling="no" allowfullscreen></iframe>' },
+  { type: 'music',
+    url: 'https://soundcloud.com/liluzivert/do-what-i-want-produced-by-maaly-raw-don-cannon',
+    provider_name: 'SoundCloud',
+    id: 'liluzivert/do-what-i-want-produced-by-maaly-raw-don-cannon',
+    embed: '<iframe width="100" height="120" src="//w.soundcloud.com/player/?url=https%3A%2F%2Fsoundcloud.com%2Fliluzivert%2Fdo-what-i-want-produced-by-maaly-raw-don-cannon%3Fvisual%3Dtrue" frameborder="0" scrolling="no" allowfullscreen></iframe>' },
+  { type: 'video',
+    url: 'https://www.youtube.com/watch?v=waiCd_CVxdc',
+    provider_name: 'YouTube',
+    thumbnail: 'https://img.youtube.com/vi/waiCd_CVxdc/sddefault.jpg',
+    id: 'waiCd_CVxdc',
+    embed: '<iframe width="100" height="120" src="//www.youtube.com/embed/waiCd_CVxdc?autoplay=1" frameborder="0" scrolling="no" allowfullscreen></iframe>' } ]
+```
+
+### Options
+In `embedjs.getAll` method you can pass a second parameter as options. This parameter should be an object similar to below.
+
+```
+{ 
+  width: '500', // default is 100%
+  height: '600', // default is 400 (px)
+  autoplay: false, // default is true
+}
+```

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

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

8489

increased by31.39%

Lines of code

113

increased by2.73%

Number of lines in readme file

48

increased by380%

Number of medium supply chain risk alerts

0

decreased by-100%

No dependency changes