Skip to content

Commit

Permalink
Fix array sort test failure (#64)
Browse files Browse the repository at this point in the history
* Fix array sort test failure

* Remove Makefile and associated scripts

* Test on node 14, 12, and 10

* Fix markdown of README
  • Loading branch information
bjornstar authored Aug 15, 2020
1 parent 2502c41 commit 29c8107
Show file tree
Hide file tree
Showing 9 changed files with 47 additions and 276 deletions.
8 changes: 4 additions & 4 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
language:
- node_js
node_js:
- "0.11"
- "0.10"
- "0.8"
- "14"
- "12"
- "10"
before_install:
- npm install -g npm
- npm install -g npm
35 changes: 0 additions & 35 deletions Makefile

This file was deleted.

60 changes: 30 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,12 +39,12 @@ reservoirDogs.cast[1].ears.pop();
Tomes API
=========

##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:
- array
- boolean
Expand All @@ -55,13 +55,13 @@ Returns data's type as a string. Tomes has types that exist in JSON which are:
As well as:
- undefined

###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
- BooleanTome
- NullTome
Expand All @@ -70,72 +70,72 @@ Returns a regular JavaScript version of your Tome.
- StringTome
- UndefinedTome

###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.
14 changes: 9 additions & 5 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,16 @@
"name": "@bjornstar/tomes",
"description": "Evented Storage Agnostic Data API",
"version": "1.0.0",
"author": "Bjorn Stromberg <bjornstar@gmail.com>",
"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"
},
"main": "index.js",
"devDependencies": {
Expand All @@ -20,7 +24,7 @@
"type": "git",
"url": "https://github.com/bjornstar/tomes.git"
},
"bugs" : {
"url" : "http://github.com/bjornstar/tomes/issues"
"bugs": {
"url": "http://github.com/bjornstar/tomes/issues"
}
}
57 changes: 0 additions & 57 deletions scripts/git-setup.sh

This file was deleted.

70 changes: 0 additions & 70 deletions scripts/jshint.cfg

This file was deleted.

26 changes: 0 additions & 26 deletions scripts/lint-all.sh

This file was deleted.

Loading

0 comments on commit 29c8107

Please sign in to comment.