├── .babelrc
├── .gitignore
├── .npmignore
├── README.md
├── lib
└── umd
│ ├── meteor-immutable-observer.js
│ └── meteor-immutable-observer.min.js
├── meteor
├── .meteor
│ ├── .finished-upgraders
│ ├── .gitignore
│ ├── .id
│ ├── packages
│ ├── platforms
│ ├── release
│ └── versions
├── meteor.html
├── packages
│ └── immutable-observer
│ │ ├── README.md
│ │ ├── global-meteor-immutable-observer.js
│ │ ├── package.js
│ │ └── tests
│ │ ├── Players.js
│ │ └── client
│ │ └── ImmutableObserverSpec.js
└── test
├── package.json
├── scripts
└── build.sh
├── src
├── ImmutableListObserver.js
├── ImmutableMapObserver.js
├── index.js
├── setGlobalImmutableObserver.js
└── updateDeep.js
└── webpack.config.js
/.babelrc:
--------------------------------------------------------------------------------
1 | {
2 | "stage": 0
3 | }
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | lib/*
2 | !lib/umd
3 | /node_modules
4 | npm-debug.log
5 |
--------------------------------------------------------------------------------
/.npmignore:
--------------------------------------------------------------------------------
1 | src
2 | scripts
3 | __tests__
4 | examples
5 | .babelrc
6 | .eslintrc
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # meteor-immutable-observer
2 |
3 | **(work in progress!)**
4 |
5 | This uses [`Mongo.Cursor.observe`](http://docs.meteor.com/#/full/observe) and `Mongo.Cursor.observeChanges`
6 | to provide [Immutable.js](http://facebook.github.io/immutable-js/) views of the collection and its documents.
7 | This is especially handy to pass to React pure render components; when documents are changed, a custom
8 | `updateDeep` method is used so that objects/arrays inside them that didn't change will still be `===` their
9 | previous values.
10 |
11 | ## Installation
12 |
13 | ### Node/Webpack/Browserify/jspm/HTML9 Responsive Boilerstrap JS
14 | ```
15 | npm install meteor-immutable-observer
16 | ```
17 | Then `var ImmutableObserver = require('meteor-immutable-observer')`
18 |
19 | There are Webpack UMDs in the `lib/umd` folder (they rely on `immutable` being in a commons chunk)
20 |
21 | ### Meteor Package *(not deployed here yet)*
22 | ```
23 | meteor add mindfront:immutable-observer
24 | ```
25 | This will put `ImmutableObserver` in the package scope.
26 |
27 | ## API
28 |
29 | **Note**: this doesn't seem to work properly when you `Meteor.subscribe()` to your collection within the same reactive computation. I haven't yet investigated exactly why. Right now I just `subscribe()` outside of any reactive computation.
30 |
31 | ### `ImmutableObserver.Map(cursor: Mongo.Cursor)`
32 |
33 | Begins a live query via `cursor.observeChanges`, and tracks changes in an `Immutable.Map` of documents indexed by `_id`.
34 |
35 | Theoretically this should perform better than `ImmutableObserver.List`, since it doesn't keep track of document order.
36 |
37 | **This should not be called within a reactive computation.** Since its `observeChanges` can trigger dependency
38 | changes, it could cause an infinite autorun loop.
39 |
40 | *Make sure you `stop()` the observer when done with it.*
41 |
42 | ###### Example:
43 |
44 | ```javascript
45 | var Players = new Meteor.Collection('players');
46 | var observer = ImmutableObserver.Map(Players.find({}, {limit: 10}));
47 | ...
48 | observer.stop();
49 | ```
50 |
51 | #### Methods
52 |
53 | ##### `documents(): Immutable.Map`
54 |
55 | Returns an `Immutable.Map` of the currently available documents, indexed by `_id`.
56 |
57 | Also registers a dependency on the underlying live query.
58 |
59 | ##### `stop()`
60 |
61 | Stops the live query (calls `stop()` on what `observeChanges` returned)
62 |
63 | ### `ImmutableObserver.List(cursor: Mongo.Cursor)`
64 |
65 | Begins a live query via `cursor.observe`, and tracks changes in an `Immutable.List` of documents in order.
66 |
67 | **This should not be called within a reactive computation.** Since its `observe` can trigger dependency
68 | changes, it could cause an infinite autorun loop.
69 |
70 | *Make sure you `stop()` the observer when done with it.*
71 |
72 | ###### Example:
73 |
74 | ```javascript
75 | var Players = new Meteor.Collection('players');
76 | var observer = ImmutableObserver.List(Players.find({}, {sort: {score: 1}, limit: 10}));
77 | ...
78 | observer.stop();
79 | ```
80 |
81 | #### Methods
82 |
83 | ##### `documents(): Immutable.List`
84 |
85 | Returns an `Immutable.List` of the currently available documents.
86 |
87 | Also registers a dependency on the underlying live query.
88 |
89 | ##### `stop()`
90 |
91 | Stops the live query (calls `stop()` on what `observe` returned)
92 |
93 | ## Example (not tested)
94 |
95 | ```jsx
96 | import React from 'react';
97 | import classNames from 'classnames';
98 | import ImmutableObserver from 'meteor-immutable-observer';
99 | import shouldPureComponentUpdate from 'react-pure-render/function';
100 |
101 | class Post extends React.Component {
102 | shouldComponentUpdate = shouldPureComponentUpdate
103 | render() {
104 | var {post} = this.props;
105 | return