Update readme & examples

Author: Philipp Alferov

README.md

@@ -11,7 +11,12 @@ saveAs() FileSaver interface in browsers that do not natively support it.
 - [FileSaver.js](https://github.com/eligrey/FileSaver.js/)
 - [Blob.js](https://github.com/eligrey/Blob.js/)
 
-## Installation
+File `dist/angular-file-saver.bundle.js` contains all required dependencies and
+grants access to both `Blob.js` and `FileSaver.js` polyfills via `Blob` and
+`SaveAs` services.
+
+## Installationand grants access to both `Blob.js` and `FileSaver.js`
+polyfills via `Blob` and `SaveAs` services
 Using bower:
 ```
 $ bower install angular-file-saver
@@ -21,20 +26,20 @@ Using npm:
 $ npm install angular-file-saver
 ```
 
-`dist/angular-file-saver.bundle.js` contains all required dependencies and grants access to both `Blob.js` and `FileSaver.js` polyfills via `Blob` and `SaveAs` services (include `ngFileSaver` module as a dependency first).
-
 ## Basic usage
 - Include the `ngFileSaver` module to your project;
-- Pass `FileSaver` service as a dependency;
-- Invoke `FileSaver.saveAs` and pass an object with the following set of options:
-  - `data` - data, represented as an array or a [Blob object](https://developer.mozilla.org/en/docs/Web/API/Blob);
+- Pass both `FileSaver` and `Blob` services as dependencies;
+- Create a [Blob object](https://developer.mozilla.org/en/docs/Web/API/Blob)
+passing an array with data as a first argument and an object with set of options
+as the second one: `new Blob(['text'], { type: 'text/plain;charset=utf-8' })`;
+- Invoke `FileSaver.saveAs` with the following arguments:
+  - `data` - a Blob object instance;
   - `filename`;
-  - `options` - a set of options for the [Blob constructor](https://developer.mozilla.org/en/docs/Web/API/Blob)(optional attribute);
 
 ## Example
 **JS**
 ```
-function ExampleCtrl(FileSaver) {
+function ExampleCtrl(FileSaver, Blob) {
   var vm = this;
 
   vm.val = {
@@ -43,12 +48,11 @@ function ExampleCtrl(FileSaver) {
 
   vm.download = function(text) {
 
+    var data = new Blob(['text'], { type: 'text/plain;charset=utf-8' });
+
     var config = {
-      data: [text],
-      filename: 'textfile.txt',
-      options: {
-        type: 'text/plain;charset=utf-8'
-      }
+      data: data,
+      filename: 'textfile.txt'
     };
 
     FileSaver.saveAs(config);
@@ -57,7 +61,7 @@ function ExampleCtrl(FileSaver) {
 
 angular
   .module('fileSaverExample', ['ngFileSaver'])
-  .controller('ExampleCtrl', [FileSaver', ExampleCtrl]);
+  .controller('ExampleCtrl', ['FileSaver', 'Blob', ExampleCtrl]);
 ```
 
 **HTML**

docs/assets/js/custom.js

@@ -1,4 +1,5 @@
-'use strict'
+'use strict';
+
 var angular = require('angular');
 require('../../../src/angular-file-saver-bundle.module');
 
@@ -11,12 +12,11 @@ function DownloadText(FileSaver) {
 
   vm.download = function(text) {
 
+    var data = new Blob([text], { type: 'text/plain;charset=utf-8' });
+
     var config = {
-      data: [text],
-      filename: 'textfile.txt',
-      options: {
-        type: 'text/plain;charset=utf-8'
-      }
+      data: data,
+      filename: 'textfile.txt'
     };
 
     FileSaver.saveAs(config);

docs/dist/examples.js

@@ -1,5 +1,6 @@
 (function e(t,n,r){function s(o,u){if(!n[o]){if(!t[o]){var a=typeof require=="function"&&require;if(!u&&a)return a(o,!0);if(i)return i(o,!0);var f=new Error("Cannot find module '"+o+"'");throw f.code="MODULE_NOT_FOUND",f}var l=n[o]={exports:{}};t[o][0].call(l.exports,function(e){var n=t[o][1][e];return s(n?n:e)},l,l.exports,e,t,n,r)}return n[o].exports}var i=typeof require=="function"&&require;for(var o=0;o<r.length;o++)s(r[o]);return s})({1:[function(require,module,exports){
-'use strict'
+'use strict';
+
 var angular = require('angular');
 require('../../../src/angular-file-saver-bundle.module');
 
@@ -12,12 +13,11 @@ function DownloadText(FileSaver) {
 
   vm.download = function(text) {
 
+    var data = new Blob([text], { type: 'text/plain;charset=utf-8' });
+
     var config = {
-      data: [text],
-      filename: 'textfile.txt',
-      options: {
-        type: 'text/plain;charset=utf-8'
-      }
+      data: data,
+      filename: 'textfile.txt'
     };
 
     FileSaver.saveAs(config);

docs/dist/examples.min.js

@@ -33,26 +33,31 @@ <h2 id="dependencies">Dependencies</h2>
 <li><a href="https://github.com/eligrey/FileSaver.js/">FileSaver.js</a></li>
 <li><a href="https://github.com/eligrey/Blob.js/">Blob.js</a></li>
 </ul>
-<h2 id="installation">Installation</h2>
-<p>Using bower:</p>
+<p>File <code>dist/angular-file-saver.bundle.js</code> contains all required dependencies and
+grants access to both <code>Blob.js</code> and <code>FileSaver.js</code> polyfills via <code>Blob</code> and
+<code>SaveAs</code> services.</p>
+<h2 id="installationand-grants-access-to-both-blob-js-and-filesaver-js-">Installationand grants access to both <code>Blob.js</code> and <code>FileSaver.js</code></h2>
+<p>polyfills via <code>Blob</code> and <code>SaveAs</code> services
+Using bower:</p>
 <pre><code>$ bower install angular-file-saver
 </code></pre><p>Using npm:</p>
 <pre><code>$ npm install angular-file-saver
-</code></pre><p><code>dist/angular-file-saver.bundle.js</code> contains all required dependencies and grants access to both <code>Blob.js</code> and <code>FileSaver.js</code> polyfills via <code>Blob</code> and <code>SaveAs</code> services (include <code>ngFileSaver</code> module as a dependency first).</p>
-<h2 id="basic-usage">Basic usage</h2>
+</code></pre><h2 id="basic-usage">Basic usage</h2>
 <ul>
 <li>Include the <code>ngFileSaver</code> module to your project;</li>
-<li>Pass <code>FileSaver</code> service as a dependency;</li>
-<li>Invoke <code>FileSaver.saveAs</code> and pass an object with the following set of options:<ul>
-<li><code>data</code> - data, represented as an array or a <a href="https://developer.mozilla.org/en/docs/Web/API/Blob">Blob object</a>;</li>
+<li>Pass both <code>FileSaver</code> and <code>Blob</code> services as dependencies;</li>
+<li>Create a <a href="https://developer.mozilla.org/en/docs/Web/API/Blob">Blob object</a>
+passing an array with data as a first argument and an object with set of options
+as the second one: <code>new Blob([&#39;text&#39;], { type: &#39;text/plain;charset=utf-8&#39; })</code>;</li>
+<li>Invoke <code>FileSaver.saveAs</code> with the following arguments:<ul>
+<li><code>data</code> - a Blob object instance;</li>
 <li><code>filename</code>;</li>
-<li><code>options</code> - a set of options for the <a href="https://developer.mozilla.org/en/docs/Web/API/Blob">Blob constructor</a>(optional attribute);</li>
 </ul>
 </li>
 </ul>
 <h2 id="example">Example</h2>
 <p><strong>JS</strong></p>
-<pre><code>function ExampleCtrl(FileSaver) {
+<pre><code>function ExampleCtrl(FileSaver, Blob) {
   var vm = this;
 
   vm.val = {
@@ -61,12 +66,11 @@ <h2 id="example">Example</h2>
 
   vm.download = function(text) {
 
+    var data = new Blob([&#39;text&#39;], { type: &#39;text/plain;charset=utf-8&#39; });
+
     var config = {
-      data: [text],
-      filename: &#39;textfile.txt&#39;,
-      options: {
-        type: &#39;text/plain;charset=utf-8&#39;
-      }
+      data: data,
+      filename: &#39;textfile.txt&#39;
     };
 
     FileSaver.saveAs(config);
@@ -75,7 +79,7 @@ <h2 id="example">Example</h2>
 
 angular
   .module(&#39;fileSaverExample&#39;, [&#39;ngFileSaver&#39;])
-  .controller(&#39;ExampleCtrl&#39;, [FileSaver&#39;, ExampleCtrl]);
+  .controller(&#39;ExampleCtrl&#39;, [&#39;FileSaver&#39;, &#39;Blob&#39;, ExampleCtrl]);
 </code></pre><p><strong>HTML</strong></p>
 <pre><code>&lt;div class=&quot;wrapper&quot; ng-controller=&quot;ExampleCtrl as vm&quot;&gt;
   &lt;textarea