https://github.com/benjohnde/delegable-proxy

Multi-level deepened proxy.
https://github.com/benjohnde/delegable-proxy

Last synced: 22 days ago
JSON representation

Multi-level deepened proxy.

• Host: GitHub
• URL: https://github.com/benjohnde/delegable-proxy
• Owner: benjohnde
• License: mit
• Created: 2016-12-19T15:16:00.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2018-02-13T18:12:45.000Z (over 6 years ago)
• Last Synced: 2024-09-26T05:23:26.386Z (about 1 month ago)
• Language: JavaScript
• Homepage:
• Size: 77.1 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# delegable-proxy

Multi-level deepened proxy, works sync.

[![Build Status](https://travis-ci.org/benjohnde/delegable-proxy.svg?branch=master)](https://travis-ci.org/benjohnde/delegable-proxy)

[![npm version](https://badge.fury.io/js/delegable-proxy.svg)](https://badge.fury.io/js/delegable-proxy)

[![Maintainability](https://api.codeclimate.com/v1/badges/853f4e7f83c9af1a73c5/maintainability)](https://codeclimate.com/github/benjohnde/delegable-proxy/maintainability)

[![Test Coverage](https://api.codeclimate.com/v1/badges/853f4e7f83c9af1a73c5/test_coverage)](https://codeclimate.com/github/benjohnde/delegable-proxy/test_coverage)

## Main purpose

For convenience sake we want to work with common lists and objects but keep track of every change to commit them to the underlying storage.

`Object.observe()` and `Array.observe()` are pretty much the exact thing we want, but both work async via polling.

The proxy returns the type of mutation (`add`, `del`, `mod`) and which position (in root object) is affected.

## Example

```javascript

import DelegableProxy from 'delegable-proxy'

const example = [{'message': 'hello world'}]

const data = DelegableProxy.wire(example, (action, pos) => {

  console.log(action, pos)

})

data.push({'message': 'hi there!'})

data.push({'message': 'knock knock!'})

```

## RunKit

https://runkit.com/586ca4b68acd620014d54362/586ca4b68acd620014d54363

## Known issues

- The way `Array.splice` works, leads to a lot of mutations on inner arrays. Better use the slow `delete foo[42].bar.stuff[0]`.

- We do not recommend to use this library in a production environment. This was just a fun project, some kind of PoC for us. We still use it in a dev environment which is only used internally.

## Usage

```bash

# add the library

yarn add delegable-proxy

# build the library

yarn build

# run the tests

yarn test

```