initial commit

Author: Rich-Harris

.gitignore

@@ -0,0 +1,4 @@
+.DS_Store
+node_modules
+*.d.ts
+dist

.travis.yml

@@ -0,0 +1,7 @@
+language: node_js
+node_js:
+  - "8"
+
+env:
+  global:
+    - BUILD_TIMEOUT=10000

CHANGELOG.md

@@ -0,0 +1,5 @@
+# TODO changelog
+
+## 1.0.0
+
+* First release

LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2019 Rich Harris
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -0,0 +1,100 @@
+# object-cull
+
+Create a copy of an object, based on which properties were accessed.
+
+```js
+import { prepare, apply } from 'object-cull';
+
+const proxy = prepare({
+	firstname: 'Terrell',
+	lastname: 'Snider',
+	friends: [
+		{ firstname: 'Rachelle', lastname: 'Knight' },
+		{ firstname: 'Ila', lastname: 'Farrell' },
+		{ firstname: 'Vasquez', lastname: 'Flynn' }
+	],
+	pets: [
+		{ name: 'Bobo', species: 'Great Dane' }
+	]
+});
+
+console.log(proxy.firstname); // Terrell
+console.log(proxy.friends[0].firstname); // Rachelle
+
+const { kept, culled } = apply(proxy);
+
+console.log(kept);
+/*
+{ firstname: 'Terrell', friends: [ { firstname: 'Rachelle' } ] }
+*/
+
+console.log(culled);
+/*
+[
+	{ path: 'lastname', value: 'Snider' },
+	{ path: 'friends.0.lastname', value: 'Knight' },
+	{ path: 'friends.1', value: { firstname: 'Ila', lastname: 'Farrell' } },
+	{ path: 'friends.2', value: { firstname: 'Vasquez', lastname: 'Flynn' } },
+	{ path: 'pets', value: [ { name: 'Bobo', species: 'Great Dane' } ] }
+]
+*/
+
+const { prepare, apply } = require('./');
+
+const proxy = prepare({
+	firstname: 'Terrell',
+	lastname: 'Snider',
+	friends: [
+		{ firstname: 'Rachelle', lastname: 'Knight' },
+		{ firstname: 'Ila', lastname: 'Farrell' },
+		{ firstname: 'Vasquez', lastname: 'Flynn' }
+	],
+	pets: [
+		{ name: 'Bobo', species: 'Great Dane' }
+	]
+});
+
+console.log(proxy.firstname); // Terrell
+console.log(proxy.friends[0].firstname); // Rachelle
+
+const { kept, culled } = apply(proxy);
+
+console.log(kept);
+/*
+{ firstname: 'Terrell', friends: [ { firstname: 'Rachelle' } ] }
+*/
+
+console.log(culled);
+/*
+[
+	{ path: 'lastname', value: 'Snider' },
+	{ path: 'friends.0.lastname', value: 'Knight' },
+	{ path: 'friends.1', value: { firstname: 'Ila', lastname: 'Farrell' } },
+	{ path: 'friends.2', value: { firstname: 'Vasquez', lastname: 'Flynn' } },
+	{ path: 'pets', value: [ { name: 'Bobo', species: 'Great Dane' } ] }
+]
+*/
+
+const unused_bytes = culled.reduce((total, item) => {
+	return total + JSON.stringify(item.value).length;
+}, 0);
+
+const percent_unused = 100 * unused_bytes / JSON.stringify(proxy).length;
+
+console.log(`${percent_unused}% of the data was unused`);
+```
+
+
+## Why?
+
+Mostly for server-side rendering. You might not to serialize *all* your data to send it to the client.
+
+
+## Prior art
+
+* [js-off](https://github.com/reconbot/js-off)
+
+
+## License
+
+MIT

appveyor.yml

@@ -0,0 +1,30 @@
+# http://www.appveyor.com/docs/appveyor-yml
+
+version: "{build}"
+
+clone_depth: 10
+
+init:
+  - git config --global core.autocrlf false
+
+environment:
+  matrix:
+    # node.js
+    - nodejs_version: 8
+
+install:
+  - ps: Install-Product node $env:nodejs_version
+  - npm install
+
+build: off
+
+test_script:
+  - node --version && npm --version
+  - npm test
+
+matrix:
+  fast_finish: false
+
+# cache:
+#   - C:\Users\appveyor\AppData\Roaming\npm-cache -> package.json     # npm cache
+#   - node_modules -> package.json                                    # local npm modules

mocha.opts

@@ -0,0 +1,2 @@
+--require sucrase/register
+test/test.ts