Skip to content

Commit

Permalink
rename to observ-struct
Browse files Browse the repository at this point in the history
  • Loading branch information
Raynos committed Jun 2, 2014
1 parent 7b3907b commit 96762d0
Show file tree
Hide file tree
Showing 4 changed files with 31 additions and 31 deletions.
38 changes: 19 additions & 19 deletions README.md
@@ -1,4 +1,4 @@
# observ-hash
# observ-struct

<!--
[![build status][1]][2]
Expand All @@ -21,12 +21,12 @@ Nested keys will still be the same value if they were not changed
in that particular `.set()` call.

```js
var ObservHash = require("observ-hash")
var ObservStruct = require("observ-struct")
var Observ = require("observ")
var assert = require("assert")

var state = ObservHash({
fruits: ObservHash({
var state = ObservStruct({
fruits: ObservStruct({
apples: Observ(3),
oranges: Observ(5)
}),
Expand All @@ -53,9 +53,9 @@ state.fruits.apples.set(4)

## Docs

### `var obj = ObservHash(opts)`
### `var obj = ObservStruct(opts)`

`ObservHash()` takes an object literal of string keys to either
`ObservStruct()` takes an object literal of string keys to either
normal values or observable values.

It returns an `Observ` instance `obj`. The value of `obj` is
Expand All @@ -69,23 +69,23 @@ Whenever one of the observables on a `key` changes the `obj` will

## Installation

`npm install observ-hash`
`npm install observ-struct`

## Contributors

- Raynos

## MIT Licenced

[1]: https://secure.travis-ci.org/Raynos/observ-hash.png
[2]: https://travis-ci.org/Raynos/observ-hash
[3]: https://badge.fury.io/js/observ-hash.png
[4]: https://badge.fury.io/js/observ-hash
[5]: https://coveralls.io/repos/Raynos/observ-hash/badge.png
[6]: https://coveralls.io/r/Raynos/observ-hash
[7]: https://gemnasium.com/Raynos/observ-hash.png
[8]: https://gemnasium.com/Raynos/observ-hash
[9]: https://david-dm.org/Raynos/observ-hash.png
[10]: https://david-dm.org/Raynos/observ-hash
[11]: https://ci.testling.com/Raynos/observ-hash.png
[12]: https://ci.testling.com/Raynos/observ-hash
[1]: https://secure.travis-ci.org/Raynos/observ-struct.png
[2]: https://travis-ci.org/Raynos/observ-struct
[3]: https://badge.fury.io/js/observ-struct.png
[4]: https://badge.fury.io/js/observ-struct
[5]: https://coveralls.io/repos/Raynos/observ-struct/badge.png
[6]: https://coveralls.io/r/Raynos/observ-struct
[7]: https://gemnasium.com/Raynos/observ-struct.png
[8]: https://gemnasium.com/Raynos/observ-struct
[9]: https://david-dm.org/Raynos/observ-struct.png
[10]: https://david-dm.org/Raynos/observ-struct
[11]: https://ci.testling.com/Raynos/observ-struct.png
[12]: https://ci.testling.com/Raynos/observ-struct
2 changes: 1 addition & 1 deletion docs.mli
@@ -1,3 +1,3 @@

observ-hash := (Object<String, Observ<T>>) =>
observ-struct := (Object<String, Observ<T>>) =>
Observ<Object<String, T>> & Object<String, Observ<T>>
12 changes: 6 additions & 6 deletions index.js
@@ -1,29 +1,29 @@
var Observ = require("observ")
var extend = require("xtend")

/* ObservHash := (Object<String, Observ<T>>) =>
/* ObservStruct := (Object<String, Observ<T>>) =>
Object<String, Observ<T>> &
Observ<Object<String, T> & {
_diff: Object<String, Any>
}>
*/
module.exports = ObservHash
module.exports = ObservStruct

function ObservHash(hash) {
var keys = Object.keys(hash)
function ObservStruct(struct) {
var keys = Object.keys(struct)

var initialState = {}

keys.forEach(function (key) {
var observ = hash[key]
var observ = struct[key]
initialState[key] = typeof observ === "function" ?
observ() : observ
})

var obs = Observ(initialState)
keys.forEach(function (key) {
var observ = hash[key]
var observ = struct[key]
obs[key] = observ

if (typeof observ === "function") {
Expand Down
10 changes: 5 additions & 5 deletions package.json
@@ -1,19 +1,19 @@
{
"name": "observ-hash",
"name": "observ-struct",
"version": "2.0.0",
"description": "An object with observable key value pairs",
"keywords": [],
"author": "Raynos <raynos2@gmail.com>",
"repository": "git://github.com/Raynos/observ-hash.git",
"repository": "git://github.com/Raynos/observ-struct.git",
"main": "index",
"homepage": "https://github.com/Raynos/observ-hash",
"homepage": "https://github.com/Raynos/observ-struct",
"contributors": [
{
"name": "Raynos"
}
],
"bugs": {
"url": "https://github.com/Raynos/observ-hash/issues",
"url": "https://github.com/Raynos/observ-struct/issues",
"email": "raynos2@gmail.com"
},
"dependencies": {
Expand All @@ -26,7 +26,7 @@
"licenses": [
{
"type": "MIT",
"url": "http://github.com/Raynos/observ-hash/raw/master/LICENSE"
"url": "http://github.com/Raynos/observ-struct/raw/master/LICENSE"
}
],
"scripts": {
Expand Down

0 comments on commit 96762d0

Please sign in to comment.