ember-buffered-array-promise-proxy

ember-buffered-array-promise-proxy
==============================================================================

This addon combines the concepts of ember-data's PromiseProxyMixin and PromiseManyArray
with the concepts of ember-buffered-array-proxy to create a promise version of a buffered
array proxy. This is useful when you are dealing with a PromiseManyArray from an async
hasMany relationship.

This addon is currently a work in progress. Please help by contributing.

Installation
------------------------------------------------------------------------------

``
ember install ember-buffered-array-promise-proxy
`

Usage
------------------------------------------------------------------------------

`sh
ember install ember-buffered-array-proxy
`

`js
import BufferedArrayPromiseProxy from 'ember-buffered-array-promise-proxy/proxy';

const content = ['A'];
const promiseArray = BufferedArrayPromiseProxy.create({ content: RSVP.resolve(content) });

promiseArray.then(bufferedArray => {
bufferedArray.get('firstObject'); // => 'A'
bufferedArray.addObject('B');

bufferedArray.objectAt(1); // => 'B'
bufferedArray.toArray(); // => ['A', 'B']

bufferedArray.get('hasChanges'); // => true
bufferedArray.get('changes'); // => (get an object describing the changes) -- { added: ['B'], removed: [] }

bufferedArray.applyBufferedChanges();

bufferedArray.toArray(); // => ['A', 'B']
bufferedArray.get('content').toArray(); // => ['A', 'B']
bufferedArray.get('hasChanges'); // => false

bufferedArray.removeObject('A');
bufferedArray.get('changes'); // => { added: [], removed: ['A'] }
bufferedArray.hasChanged(); // => true

bufferedArray.discardBufferedChanges();

bufferedArray.toArray(); // => ['A', 'B']
bufferedArray.get('content').toArray(); // => ['A', 'B']
bufferedArray.hasChanged(); // => false
});
`

Or you can grab the mixin directly

`js
import BufferedArrayPromiseMixin from 'ember-buffered-array-promise-proxy/mixin';

const content = ['A'];
const promise = EmberObject.extend(BufferedArrayPromiseProxyMixin).create({ content: RSVP.resolve(content) });
`

You can also use a few of these methods directly returning promises:

`js
promiseArray.discardChanges();
promiseArray.discardpromiseArrayedChanges();
promiseArray.objectAt(1);
promiseArray.toArray();
`

Or you can even use this awesome computed property macro:

`js
import { bufferedArrayPromise } from 'ember-buffered-array-promise-proxy/cp-macros';

// ...

bufferedPromisePosts: bufferedArrayPromise('posts')
`


Contributing
------------------------------------------------------------------------------

$3

* git clone
* cd ember-buffered-array-promise-proxy
* yarn install

$3

* yarn lint:js
* yarn lint:js --fix

$3

* ember test – Runs the test suite on the current Ember version
* ember test --server – Runs the test suite in "watch mode"
* yarn test – Runs ember try:each to test your addon against multiple Ember versions

$3

* ember serve`
* Visit the dummy application at http://localhost:4200.

For more information on using ember-cli, visit https://ember-cli.com/.

License
------------------------------------------------------------------------------

This project is licensed under the MIT License.