https://github.com/dashed/minitrue
Probe cursor factory
https://github.com/dashed/minitrue
Last synced: 11 months ago
JSON representation
Probe cursor factory
- Host: GitHub
- URL: https://github.com/dashed/minitrue
- Owner: dashed
- License: mit
- Created: 2015-05-20T15:14:14.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2015-06-12T17:27:42.000Z (over 10 years ago)
- Last Synced: 2025-02-18T06:04:58.176Z (12 months ago)
- Language: JavaScript
- Homepage:
- Size: 195 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# minitrue [](https://travis-ci.org/Dashed/minitrue)
> War is Peace
>
> Freedom is Slavery
>
> Ignorance is Strength
>
> — **Ministry of Truth**
`minitrue` (Ministry of Truth) create `Probe` cursors that reference a single object reference containing an Immutable Map.
All created `Probe` cursors via another `Probe` cursor point to the same single source of truth.
Any two `Probe` cursors with the same keypath will point to the same value.
## Usage
```
$ npm install --save minitrue
```
### API
### `minitrue`
Create and return a `Probe` object with `data` as its unboxed root data.
If `data` is not an `Immutable` collection, it'll be converted into one via
`Immutable.fromJS(data)`.
```js
const truth = minitrue({
'two plus two': {
answer: 'five'
}
});
```
### `Probe`
See [Probe API](https://github.com/Dashed/probe).
## FAQ
### WTF is minitrue?
`minitrue`, otherwise known as the Ministry of Truth, is an organization in George Orwell's novel, *Nineteen Eighty-Four*, that manages propaganda within a region called Oceania.
Sources:
- https://en.wikipedia.org/wiki/Ministry_of_Truth
## License
MIT