Skip to content

Commit 29c8107

Browse files
authored
Fix array sort test failure (#64)
* Fix array sort test failure * Remove Makefile and associated scripts * Test on node 14, 12, and 10 * Fix markdown of README
1 parent 2502c41 commit 29c8107

File tree

9 files changed

+47
-276
lines changed

9 files changed

+47
-276
lines changed

.travis.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
language:
22
- node_js
33
node_js:
4-
- "0.11"
5-
- "0.10"
6-
- "0.8"
4+
- "14"
5+
- "12"
6+
- "10"
77
before_install:
8-
- npm install -g npm
8+
- npm install -g npm

Makefile

Lines changed: 0 additions & 35 deletions
This file was deleted.

README.md

Lines changed: 30 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -39,12 +39,12 @@ reservoirDogs.cast[1].ears.pop();
3939
Tomes API
4040
=========
4141

42-
##Tome
42+
## Tome
4343

44-
###Tome.conjure( *data* )
44+
### Tome.conjure( *data* )
4545
Returns a new Tome containing your data.
4646

47-
###Tome.typeOf( *data* )
47+
### Tome.typeOf( *data* )
4848
Returns data's type as a string. Tomes has types that exist in JSON which are:
4949
- array
5050
- boolean
@@ -55,13 +55,13 @@ Returns data's type as a string. Tomes has types that exist in JSON which are:
5555
As well as:
5656
- undefined
5757

58-
###Tome.isTome( *data* )
58+
### Tome.isTome( *data* )
5959
Returns a boolean indicating whether data is a Tome or not.
6060

61-
###Tome.unTome( *tome* )
61+
### Tome.unTome( *tome* )
6262
Returns a regular JavaScript version of your Tome.
6363

64-
##TomeTypes
64+
## TomeTypes
6565
- ArrayTome
6666
- BooleanTome
6767
- NullTome
@@ -70,72 +70,72 @@ Returns a regular JavaScript version of your Tome.
7070
- StringTome
7171
- UndefinedTome
7272

73-
###Tome.destroy( *tome* )
73+
### Tome.destroy( *tome* )
7474
Make a tome and all of it's sub-tomes emit destroy. This will not delete anything.
7575

76-
##Methods
76+
## Methods
7777

78-
###assign( *data* )
78+
### assign( *data* )
7979
Assign data to a Tome.
8080

81-
###set( *key*, *data* )
81+
### set( *key*, *data* )
8282
Assign data to key on a Tome. Set will create a Tome on the key if it does not exist.
8383

84-
###del( *key* )
84+
### del( *key* )
8585
Delete a key from a Tome.
8686

87-
###swap( *key*, *tome* )
87+
### swap( *key*, *tome* )
8888
Swap key with tome.
8989

90-
###rename( *key*, *newkey* )
90+
### rename( *key*, *newkey* )
9191
Rename key to newkey.
9292

93-
###move( *key*, *tome*, [ *newkey* ] )
93+
### move( *key*, *tome*, [ *newkey* ] )
9494
Move key to tome. Optionally call it newkey on that tome.
9595

96-
###read( )
96+
### read( )
9797
Get a single change operation from the root Tome, removing it in the process. Returns null if there are no changes.
9898

99-
###readAll( )
99+
### readAll( )
100100
Get all change operations from the Tome
101101

102-
###merge( *diff* )
102+
### merge( *diff* )
103103
Applies a change operation or an array of change operations to a Tome.
104104

105-
###destroy( )
105+
### destroy( )
106106
Makes the tome and all of it's sub-tomes emit destroy. Does not delete anything.
107107

108-
###unTome( )
108+
### unTome( )
109109
Returns a regular javascript version of your Tome.
110110

111-
###getKey( )
111+
### getKey( )
112112
Returns a Tome's key.
113113

114-
###getParent( )
114+
### getParent( )
115115
Returns a Tome's parent Tome.
116116

117-
###getVersion( )
117+
### getVersion( )
118118
Returns a Tome's version.
119119

120-
###is( *value* )
120+
### is( *value* )
121121
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.
122122

123-
###isDirty( )
123+
### isDirty( )
124124
Returns whether a Tome has been changed, but the change has not been read.
125125

126-
##Events
126+
## Events
127127

128-
###add( *key* )
128+
### add( *key* )
129129
Emitted when a Tome receives a new key.
130130

131-
###del( *key* )
131+
### del( *key* )
132132
Emitted when a key is deleted from a Tome.
133133

134-
###destroy( )
134+
### destroy( )
135135
Emitted when a Tome is deleted. Removes all event listeners for this Tome.
136136

137-
###readable( *was* )
137+
### readable( *was* )
138138
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.
139139

140-
###typeChange( *tome*, *oldType*, *newType* )
140+
### typeChange( *tome*, *oldType*, *newType* )
141141
Emitted by the root tome when a Tome changes type.

package.json

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,16 @@
22
"name": "@bjornstar/tomes",
33
"description": "Evented Storage Agnostic Data API",
44
"version": "1.0.0",
5-
"author": "Bjorn Stromberg <bjornstar@gmail.com>",
5+
"author": "Bjorn Stromberg <bjorn@bjornstar.com>",
66
"maintainers": [
7-
{ "name": "Bjorn Stromberg", "email": "[email protected]" }
7+
{
8+
"name": "Bjorn Stromberg",
9+
"email": "[email protected]"
10+
}
811
],
912
"scripts": {
10-
"test": "jshint index.js && node test"
13+
"lint": "jshint index.js",
14+
"test": "node test"
1115
},
1216
"main": "index.js",
1317
"devDependencies": {
@@ -20,7 +24,7 @@
2024
"type": "git",
2125
"url": "https://github.com/bjornstar/tomes.git"
2226
},
23-
"bugs" : {
24-
"url" : "http://github.com/bjornstar/tomes/issues"
27+
"bugs": {
28+
"url": "http://github.com/bjornstar/tomes/issues"
2529
}
2630
}

scripts/git-setup.sh

Lines changed: 0 additions & 57 deletions
This file was deleted.

scripts/jshint.cfg

Lines changed: 0 additions & 70 deletions
This file was deleted.

scripts/lint-all.sh

Lines changed: 0 additions & 26 deletions
This file was deleted.

0 commit comments

Comments
 (0)