@bjornstar/tomes
Advanced tools
Comparing version 1.0.0 to 1.1.0
@@ -1,58 +0,65 @@ | ||
#Tomes Release Notes | ||
# @bjornstar/tomes Release Notes | ||
##1.0.0 | ||
* Repeated calls to unTome return the same object | ||
## 1.1.0 / 2020-08-15 | ||
* Fix array sort test failure | ||
* Remove Makefile and associated scripts | ||
* Test on node 14, 12, and 10 | ||
* Fix markdown of HISTORY | ||
* Fix markdown of README | ||
##1.0.0-beta.5 | ||
* Tomes now have a destroy method | ||
* Add .jshintrc and run on tests | ||
## 1.0.0 | ||
* Repeated calls to unTome return the same object | ||
##1.0.0-beta.4 | ||
* Update `README.md` to fix first link | ||
## 1.0.0-beta.5 | ||
* Tomes now have a destroy method | ||
* Add .jshintrc and run on tests | ||
##1.0.0-beta.3 | ||
* Update `README.md` to point to this fork | ||
## 1.0.0-beta.4 | ||
* Update `README.md` to fix first link | ||
##1.0.0-beta.2 | ||
* Tomes now have an unTome method | ||
* Fix a few lint errors in tests | ||
## 1.0.0-beta.3 | ||
* Update `README.md` to point to this fork | ||
##1.0.0-beta.1 | ||
* Remove component.json | ||
* Always use node events library | ||
* Now available as @bjornstar/tomes | ||
* Export Tome directly | ||
* Put types on Tome itself | ||
## 1.0.0-beta.2 | ||
* Tomes now have an unTome method | ||
* Fix a few lint errors in tests | ||
##0.1.0 | ||
* Removed the hide method, it was useless and only increased code complexity. | ||
* Added nodei.co badge. | ||
* Added node v0.11 back to travis, maybe it will work now. | ||
* unset executable bit from files. | ||
## 1.0.0-beta.1 | ||
* Remove component.json | ||
* Always use node events library | ||
* Now available as @bjornstar/tomes | ||
* Export Tome directly | ||
* Put types on Tome itself | ||
##0.0.22 | ||
* inc now takes NumberTomes | ||
* Added this `HISTORY.md` file | ||
## 0.1.0 | ||
* Removed the hide method, it was useless and only increased code complexity. | ||
* Added nodei.co badge. | ||
* Added node v0.11 back to travis, maybe it will work now. | ||
* unset executable bit from files. | ||
##0.0.21 | ||
* IE9 support and travis fix for npm horribleness | ||
## 0.0.22 | ||
* inc now takes NumberTomes | ||
* Added this `HISTORY.md` file | ||
##0.0.20 | ||
* toLocaleString does not work in browsers so we make a special one for them. | ||
## 0.0.21 | ||
* IE9 support and travis fix for npm horribleness | ||
##0.0.19 | ||
* Tomes now behaves similar to JSON in that it throws a TypeError when it detects circular | ||
references in the data you passed to it. Tomes now does this on conjure and on unTome. | ||
## 0.0.20 | ||
* toLocaleString does not work in browsers so we make a special one for them. | ||
##0.0.18 | ||
* ArrayTome.indexOf and lastIndexOf now do a valueOf on the value to be searched for. | ||
## 0.0.19 | ||
* Tomes now behaves similar to JSON in that it throws a TypeError when it detects circular | ||
references in the data you passed to it. Tomes now does this on conjure and on unTome. | ||
##0.0.17 | ||
* To avoid issues with multiple versions of Tomes not being able to recognize Tomes as Tomes, | ||
instanceof has been eradicated from Tomes. Instead we now check the to see if the constructor's | ||
name has Tomes in it. This is not perfect as Tomes will still fail to recognize Tomes from other | ||
iframes and windows. It's a step in the right direction regardless. | ||
## 0.0.18 | ||
* ArrayTome.indexOf and lastIndexOf now do a valueOf on the value to be searched for. | ||
Additionally, Tomes now has a readAll method to pull out the entire array of diffs from the root | ||
Tome. It seems like the vast majority of use cases always pull out all diffs, so this should | ||
improve performance there. | ||
## 0.0.17 | ||
* To avoid issues with multiple versions of Tomes not being able to recognize Tomes as Tomes, | ||
instanceof has been eradicated from Tomes. Instead we now check the to see if the constructor's | ||
name has Tomes in it. This is not perfect as Tomes will still fail to recognize Tomes from other | ||
iframes and windows. It's a step in the right direction regardless. | ||
Additionally, Tomes now has a readAll method to pull out the entire array of diffs from the root | ||
Tome. It seems like the vast majority of use cases always pull out all diffs, so this should | ||
improve performance there. |
{ | ||
"name": "@bjornstar/tomes", | ||
"description": "Evented Storage Agnostic Data API", | ||
"version": "1.0.0", | ||
"author": "Bjorn Stromberg <bjornstar@gmail.com>", | ||
"version": "1.1.0", | ||
"author": "Bjorn Stromberg <bjorn@bjornstar.com>", | ||
"maintainers": [ | ||
{ "name": "Bjorn Stromberg", "email": "bjornstar@gmail.com" } | ||
{ | ||
"name": "Bjorn Stromberg", | ||
"email": "bjorn@bjornstar.com" | ||
} | ||
], | ||
"scripts": { | ||
"test": "jshint index.js && node test" | ||
"lint": "jshint index.js", | ||
"test": "node test" | ||
}, | ||
@@ -23,5 +27,5 @@ "main": "index.js", | ||
}, | ||
"bugs" : { | ||
"url" : "http://github.com/bjornstar/tomes/issues" | ||
"bugs": { | ||
"url": "http://github.com/bjornstar/tomes/issues" | ||
} | ||
} |
@@ -42,8 +42,8 @@ [](https://nodei.co/npm/@bjornstar/tomes) | ||
##Tome | ||
## Tome | ||
###Tome.conjure( *data* ) | ||
### Tome.conjure( *data* ) | ||
Returns a new Tome containing your data. | ||
###Tome.typeOf( *data* ) | ||
### Tome.typeOf( *data* ) | ||
Returns data's type as a string. Tomes has types that exist in JSON which are: | ||
@@ -59,9 +59,9 @@ - array | ||
###Tome.isTome( *data* ) | ||
### Tome.isTome( *data* ) | ||
Returns a boolean indicating whether data is a Tome or not. | ||
###Tome.unTome( *tome* ) | ||
### Tome.unTome( *tome* ) | ||
Returns a regular JavaScript version of your Tome. | ||
##TomeTypes | ||
## TomeTypes | ||
- ArrayTome | ||
@@ -75,70 +75,70 @@ - BooleanTome | ||
###Tome.destroy( *tome* ) | ||
### Tome.destroy( *tome* ) | ||
Make a tome and all of it's sub-tomes emit destroy. This will not delete anything. | ||
##Methods | ||
## Methods | ||
###assign( *data* ) | ||
### assign( *data* ) | ||
Assign data to a Tome. | ||
###set( *key*, *data* ) | ||
### set( *key*, *data* ) | ||
Assign data to key on a Tome. Set will create a Tome on the key if it does not exist. | ||
###del( *key* ) | ||
### del( *key* ) | ||
Delete a key from a Tome. | ||
###swap( *key*, *tome* ) | ||
### swap( *key*, *tome* ) | ||
Swap key with tome. | ||
###rename( *key*, *newkey* ) | ||
### rename( *key*, *newkey* ) | ||
Rename key to newkey. | ||
###move( *key*, *tome*, [ *newkey* ] ) | ||
### move( *key*, *tome*, [ *newkey* ] ) | ||
Move key to tome. Optionally call it newkey on that tome. | ||
###read( ) | ||
### read( ) | ||
Get a single change operation from the root Tome, removing it in the process. Returns null if there are no changes. | ||
###readAll( ) | ||
### readAll( ) | ||
Get all change operations from the Tome | ||
###merge( *diff* ) | ||
### merge( *diff* ) | ||
Applies a change operation or an array of change operations to a Tome. | ||
###destroy( ) | ||
### destroy( ) | ||
Makes the tome and all of it's sub-tomes emit destroy. Does not delete anything. | ||
###unTome( ) | ||
### unTome( ) | ||
Returns a regular javascript version of your Tome. | ||
###getKey( ) | ||
### getKey( ) | ||
Returns a Tome's key. | ||
###getParent( ) | ||
### getParent( ) | ||
Returns a Tome's parent Tome. | ||
###getVersion( ) | ||
### getVersion( ) | ||
Returns a Tome's version. | ||
###is( *value* ) | ||
### is( *value* ) | ||
Returns a boolean value indicating whether or not the Tome is observably indistinguishable from value ([ref](http://wiki.ecmascript.org/doku.php?id=harmony:egal)). If no value is given, returns whether or not the Tome's value is truthy. | ||
###isDirty( ) | ||
### isDirty( ) | ||
Returns whether a Tome has been changed, but the change has not been read. | ||
##Events | ||
## Events | ||
###add( *key* ) | ||
### add( *key* ) | ||
Emitted when a Tome receives a new key. | ||
###del( *key* ) | ||
### del( *key* ) | ||
Emitted when a key is deleted from a Tome. | ||
###destroy( ) | ||
### destroy( ) | ||
Emitted when a Tome is deleted. Removes all event listeners for this Tome. | ||
###readable( *was* ) | ||
### readable( *was* ) | ||
Emitted every time a Tome or any of its child Tomes are altered. If the Tome was a primitive (ie. string, number, or boolean) the previous value will be emitted as well, but only if it did not change types. | ||
###typeChange( *tome*, *oldType*, *newType* ) | ||
### typeChange( *tome*, *oldType*, *newType* ) | ||
Emitted by the root tome when a Tome changes type. |
@@ -454,4 +454,4 @@ var Tome = require('../..'); | ||
a.sort(function (a, b) { return a.valueOf() - b.valueOf(); }); | ||
b.sort(function (a, b) { return a.valueOf() - b.valueOf(); }); | ||
a.sort(); | ||
b.sort(); | ||
@@ -466,4 +466,4 @@ // 2 | ||
a.sort(function (a, b) { return a.valueOf() - b.valueOf(); }); | ||
b.sort(function (a, b) { return a.valueOf() - b.valueOf(); }); | ||
a.sort(); | ||
b.sort(); | ||
@@ -470,0 +470,0 @@ // 6 |
Sorry, the diff of this file is not supported yet
241503
27