ember-cli-file-saver/README.md

Provides file saving capability to an Ember CLI application.

# Ember-cli-file-saver

Provides support to save binary file from an API for an Ember CLI application.

## Installation

Install the ember-cli addon in your ember-cli project:

```bash
$ ember install ember-cli-file-saver
```

This should also automatically:
- add an NPM dependency to [FileSaver](https://github.com/eligrey/FileSaver.js).
- add a transport layer for jQuery to handle arraybuffer and blob dataType.

**Note** that to make this new transport layer works nicely with `ember-data` it is necessary to make your adapter extend the
`adapter-arraybuffer-mixin` mixin and pass either `arraybuffer:true` or `blob:true` as an AJAX option, otherwise `ember-data` will
try to interpret the response as JSON.


## Usage

### ES6 Import

This addon provides the ability to import FileSaver as an ES6 module.

```js
import FileSaver from 'file-saver';
```

### Adapter Mixin for ArrayBuffer / Blob response

```js
import ActiveModelAdapter from 'active-model-adapter';
import AdapterArrayBufferMixin from 'ember-cli-file-saver/mixins/adapter-arraybuffer-mixin';

const ApplicationAdapter = ActiveModelAdapter.extend(AdapterArrayBufferMixin);

ApplicationAdapter.reopen({
 // 
});

export default ApplicationAdapter;
```

### Download from a component

```js
import Ember from 'ember';
import FileSaverMixin from 'ember-cli-file-saver/mixins/file-saver';

const { Component, computed } = Ember;

export default Component.extend(FileSaverMixin, {

  tagName: 'button',

  click() {
    this.get('ajax').request(this.get('downloadUrl'), {
      method: 'GET',
      dataType: 'arraybuffer', // or 'blob'
      processData: false
    })
    .then((content) => this.saveFileAs(this.get('filename'), content, this.get('contentType')));
  }
});
```

### Using from a model

This works well with the [ember-api-actions](https://github.com/mike-north/ember-api-actions) project:

```js
// models/invoice.js

import Ember from 'ember';
import DS from 'ember-data';
import { memberAction } from 'ember-api-actions';

const { computed } = Ember;
const { belongsTo, attr, Model } = DS;

export default Model.extend({

  invoiceNumber: attr('number'),

  download: memberAction({ path: 'download', type: 'GET', ajaxOptions: { arraybuffer: true } })
});
```

```js
// in a component

invoiceModel
  .download()
  .then((pdfContent) => this.saveFileAs('invoice.pdf', pdfContent, 'application/pdf'));

```


## Installation

* `git clone <repository-url>` this repository
* `cd ember-cli-file-saver`
* `npm install`

## Running

* `ember serve`
* Visit your app at [http://localhost:4200](http://localhost:4200).

## Running Tests

* `npm test` (Runs `ember try:each` to test your addon against multiple Ember versions)
* `ember test`
* `ember test --server`

## Building

* `ember build`

For more information on using ember-cli, visit [http://ember-cli.com/](http://ember-cli.com/).