# ember-deep-buffered-proxy

> Change buffering proxy for Ember Objects, arrays, promises

Latest version **0.0.10** (published 2022-10-17) · MIT license · 0 weekly downloads

## Install

```sh
npm install ember-deep-buffered-proxy
pnpm add ember-deep-buffered-proxy
yarn add ember-deep-buffered-proxy
bun add ember-deep-buffered-proxy
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.10 |
| Published | 2022-10-17 |
| First published | 2019-07-31 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | 12.* \|\| 14.* \|\| >= 16 |
| Dependencies | 4 |
| Unpacked size | 20 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Maintainers | jembezmamy |
| Keywords | ember-addon, proxy, buffer, changeset, fork |

## Links

- npm: https://www.npmjs.com/package/ember-deep-buffered-proxy
- Repository: https://github.com/nibynic/ember-deep-buffered-proxy
- npm.io page: https://npm.io/package/ember-deep-buffered-proxy

## Dependencies (4)

- [just-extend](https://npm.io/package/just-extend.md) ^4.0.0
- [ember-cli-babel](https://npm.io/package/ember-cli-babel.md) ^7.26.10
- [ember-get-config](https://npm.io/package/ember-get-config.md) ^2.1.1
- [ember-cli-htmlbars](https://npm.io/package/ember-cli-htmlbars.md) ^5.7.2

## Alternatives

- [flatbuffers](https://npm.io/package/flatbuffers.md) — 6.0M weekly downloads
- [@exodus/patch-broken-hermes-typed-arrays](https://npm.io/package/@exodus/patch-broken-hermes-typed-arrays.md) — 28.5K weekly downloads
- [@native-to-anchor/buffer-layout](https://npm.io/package/@native-to-anchor/buffer-layout.md) — 12.2K weekly downloads
- [binary-parser-encoder](https://npm.io/package/binary-parser-encoder.md) — 5.3K weekly downloads
- [datasets-fi-postalcodes](https://npm.io/package/datasets-fi-postalcodes.md) — 1.1K weekly downloads

## Recent versions

- 0.0.10 (latest) — 2022-10-17
- 0.0.9 — 2022-10-05
- 0.0.8 — 2021-03-08
- 0.0.7 — 2020-09-10
- 0.0.6 — 2020-04-18
- 0.0.5 — 2019-10-23
- 0.0.4 — 2019-09-04
- 0.0.3 — 2019-08-14
- 0.0.2 — 2019-08-08
- 0.0.1 — 2019-08-07
- 0.0.0 — 2019-07-31

## README

Ember Deep Buffered Proxy
==============================================================================

[![Build Status](https://travis-ci.com/nibynic/ember-deep-buffered-proxy.svg?branch=master)](https://travis-ci.com/nibynic/ember-deep-buffered-proxy)
[![Ember Observer Score](https://emberobserver.com/badges/ember-deep-buffered-proxy.svg)](https://emberobserver.com/addons/ember-deep-buffered-proxy)
[![npm version](https://badge.fury.io/js/ember-deep-buffered-proxy.svg)](https://badge.fury.io/js/ember-deep-buffered-proxy)

Wrap your data in a proxy that buffers all changes - meaning that you can control
when and whether they get applied on source data.

There is plenty of buffer proxy or changeset Ember addons, this one tries to unite
all these ideas in one addon:

- Supports Ember Objects, POJOs, Arrays, Ember Arrays,
- Supports promises,
- Supports nested objects,
- Lists all changes, detects dirtiness,
- Allows you to apply or discard changes.

**If you are using EmberData, there is a more specialized addon called [Ember Data
Fork](https://github.com/nibynic/ember-data-fork).**



Compatibility
------------------------------------------------------------------------------

* Ember.js v2.12 or above
* Ember CLI v2.13 or above
* Node.js v10 or above


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

```
ember install ember-deep-buffered-proxy
```


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

```javascript
import buildProxy from 'ember-deep-buffered-proxy';

let model = {
  name: 'Cookie Monster',
  address: {
    street: 'Sesame St.'
  },
  friends: [
    { name: 'Bert' },
    { name: 'Ernie' }
  ]
};

let buffer = buildProxy(model);

buffer.set('name', 'Big Bird');
buffer.get('address').set('street', 'Sesame Street');
buffer.get('friends').popObject();
buffer.get('friends').addObject({ name: 'Elmo' });

// model has not changed

buffer.dbp.hasChanges; // true
buffer.dbp.applyChanges();

// model received the changes

buffer.dbp.hasChanges; // false
```


### Namespace

To prevent attribute name collision, all buffer methods and attributes are wrapped
inside an object that is available under `dbp` key. If you don't like this name,
you can set your own namespace in the [configuration](#configuration).


### What is considered a change?

By default Ember Deep Buffered Proxy uses JSON serialization and strict equality
to compare old and new values. That means that for example two `Date` instances
are considered same as long as they have same time value. If this mechanism
doesn't work for you, you can always provide your own serialization method in options:

```javascript
let buffer = buildProxy(model, {
  serialize(v) {
    return v; // use actual value without any serialization
  }
});
```


### Extending

Ember Deep Buffered Proxy ships with two classes: `ObjectProxy` and `ArrayProxy`.
Each of them has its own driver class (`ObjectProxy.Driver` and `ArrayProxy.Driver`) -
that's the class that gets instantiated under the namespace hook.
Here's a general idea how to extend these classes or define custom proxy class:

```javascript
import { isArray } from '@ember/array';
import buildProxy, { ObjectProxy, ArrayProxy } from 'ember-deep-buffered-proxy';

const MyObjectProxyDriver = ObjectProxy.Driver.extend({
});

const MyObjectProxy = ObjectProxy.extend({
}).reopenClass({
  Driver: MyObjectProxyDriver
});

export default function(content) {
  return buildProxy(content, {
    proxyClassFor(obj) {
      return isArray(obj) ? ArrayProxy : MyObjectProxy;
    }
  });
}
```


### Configuration

To override default configuration just define your settings in `config/environment.js`
under `deepBufferedProxy` key. These are all available options:

```javascript
{
  namespace: 'dbp' // key under which buffer methods and attributes are available
}
```


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

See the [Contributing](CONTRIBUTING.md) guide for details.


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

This project is licensed under the [MIT License](LICENSE.md).

---
_Source: https://npm.io/package/ember-deep-buffered-proxy · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
