Skip to content

Commit 0769a81

Browse files
committed
docs update
1 parent 415af8f commit 0769a81

File tree

4 files changed

+21
-16
lines changed

4 files changed

+21
-16
lines changed

CHANGELOG.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
vnext
2+
- added EJSON support (default is off) with a couple tests
3+
14
0.3.3 - 2013-05-29
25
- fixed bug where an exception could be thrown when sending a message on a socket that is not opened anymore (issue #18)
36
- added some tests (work in progress)

README.markdown

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ A callback style DDP ([Meteor](http://meteor.com/)'s Distributed Data Protocol)
55

66
Based _heavily_ on alansikora's [node-js_ddp-client](https://github.com/alansikora/node-js_ddp-client), and meteor's python client. Uses a more callback style approach.
77

8-
The client implements the pre1 version of DDP. It is unfinished at this point, but should do most of what you want it to do.
8+
The client implements the pre1 version of DDP, with optional [EJSON](http://docs.meteor.com/#ejson) support. It is unfinished at this point, but should do most of what you want it to do.
99

1010
Installation
1111
============
@@ -23,12 +23,13 @@ Please see the example in `examples/example.js`. Or here for reference:
2323
var DDPClient = require("ddp");
2424

2525
var ddpclient = new DDPClient({
26-
host: "localhost",
27-
port: 3000,
28-
/* optional: */
29-
auto_reconnect: true,
30-
auto_reconnect_timer: 500
31-
});
26+
host: "localhost",
27+
port: 3000,
28+
/* optional: */
29+
auto_reconnect: true,
30+
auto_reconnect_timer: 500,
31+
use_ejson: true // default is false
32+
});
3233

3334
ddpclient.connect(function(error) {
3435
if (error) {
@@ -76,7 +77,6 @@ Unimplemented Features
7677
* 'movedBefore'
7778
* 'error'
7879
* 'updated'
79-
* EJSON support
8080

8181

8282

examples/example.js

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
11
var DDPClient = require("../lib/ddp-client");
22

33
var ddpclient = new DDPClient({
4-
host: "localhost",
5-
port: 3000,
6-
/* optional: */
7-
auto_reconnect: true,
8-
auto_reconnect_timer: 500
9-
});
4+
host: "localhost",
5+
port: 3000,
6+
/* optional: */
7+
auto_reconnect: true,
8+
auto_reconnect_timer: 500,
9+
use_ejson: true // default is false
10+
});
1011

1112
ddpclient.connect(function(error) {
1213
console.log('connected!');

package.json

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "ddp",
3-
"version": "0.3.3",
3+
"version": "0.3.4",
44
"description": "Node.js module to connect to servers using DDP protocol.",
55
"author": "Tom Coleman <[email protected]> (http://tom.thesnail.org), Mike Bannister <[email protected]> (http://po.ssibiliti.es)",
66
"main": "lib/ddp-client",
@@ -11,7 +11,8 @@
1111
},
1212
"dependencies": {
1313
"ws": ">=0.4.23",
14-
"underscore": ">=1.3.3"
14+
"underscore": ">=1.3.3",
15+
"meteor-ejson": ">=0.6.3"
1516
},
1617
"devDependencies": {
1718
"mocha": "1.9.x",

0 commit comments

Comments
 (0)