Skip to content

Commit

Permalink
v1.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
yasserf committed Jul 10, 2016
1 parent e8c874d commit 23f598b
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 13 deletions.
24 changes: 14 additions & 10 deletions CHANGELOG.md
Expand Up @@ -3,7 +3,7 @@
### Features

###### Merge Conflict Resolution #4
Users can now set a global and per record merge strategy. This allows the application to respond to VERSION_EXISTS and using a REMOTE_WINS, LOCAL_WINS or custom merge strategy.
Users can now set a global and per record merge strategy. This allows the application to respond to `VERSION_EXISTS` and use a `REMOTE_WINS`, `LOCAL_WINS` or a custom merge strategy

Global:
```javascript
Expand All @@ -24,6 +24,7 @@ record.setMergeStrategy( ( record, remoteValue, remoteVersion, callback ) => {
#### Enhancements

###### Connection Redirects
deepstream protocol now has a connection establishment handshake that allows the client to be redirected to another deepstream before requesting/publishing data

###### Record deletes #111
Users can now delete content within records by setting it to undefined
Expand All @@ -33,26 +34,26 @@ record.set( path, undefined )
```

###### Reduced client size #75
Client size bundle has been reduced by not including mocks for the tcp connection.
Client size bundle has been reduced by not including mocks for the tcp connection

###### Discard/Delete only on ready #94
Record discards and deletes now get called after when ready, which makes the API cleaner

Before:
```javascript
record = client.record.getRecord( 'user1' );
record.set( 'name', 'bob' );
record = client.record.getRecord( 'user1' )
record.set( 'name', 'bob' )
record.onReady( () => {
record.discard();
record.discard()
})
```

Now:
```javascript
record = client.record.getRecord( 'user1' );
record = client.record.getRecord( 'user1' )
record
.set( 'name', 'bob' )
.discard();
.discard()
```

###### Exposed Constants
Expand All @@ -62,15 +63,15 @@ You can now access constants on deepstream
// on the constructor
const C = deepstream.CONSTANTS;
// and instance
const client = deepstream.login()
const client = deepstream( 'localhost:6020' )
CONST C = client.CONSTANTS;
```

### Breaking Changes

###### Login callback

The login callback now only takes two arguments instead of three. This is to make it easier for the user to send their own custom data from an authentication hander or when using the http authentication handler.
The login callback now only takes two arguments instead of three. This is to make it easier for the user to send their own custom data from an authentication hander or when using the http authentication handler

```javascript
client.login( {}, ( success, data ) => {
Expand All @@ -84,8 +85,11 @@ client.login( {}, ( success, data ) => {
} )
```

###### EngineIO Default Path
We now use `deepstream` instead of `engine.io` as the default engineio path

### Bug Fixes

- Login after logout doesn't overide auth parameters #88

- Deepstream not updating object properties #96 ( @drsirmrpresidentfathercharles )
- Deepstream not updating object properties #96 ( @drsirmrpresidentfathercharles )
6 changes: 3 additions & 3 deletions package.json
@@ -1,6 +1,6 @@
{
"name": "deepstream.io-client-js",
"version": "1.0.0-beta.1",
"version": "1.0.0",
"description": "the javascript client for deepstream.io",
"main": "src/client.js",
"directories": {
Expand All @@ -23,7 +23,7 @@
},
"dependencies": {
"component-emitter": "1.1.2",
"engine.io-client": "^1.6.8"
"engine.io-client": "^1.6.11"
},
"browser": {
"net": false
Expand All @@ -48,7 +48,7 @@
"watch": "^0.19.1"
},
"author": "deepstreamHub GmbH",
"license": "MIT",
"license": "Apache-2.0",
"bugs": {
"url": "https://github.com/deepstreamIO/deepstream.io-client-js/issues"
},
Expand Down

0 comments on commit 23f598b

Please sign in to comment.