add revisions example

Author: gregolsky

README.md

@@ -666,6 +666,41 @@ queryStream.on("error", err => {
 
 ```
 
+### Revisions
+NOTE: Please make sure revisions are enabled before trying one of the below.
+
+```javascript
+const session = store.openSession();
+const user = {
+    name: "Marcin",
+    age: 30,
+    pet: "users/4"
+};
+
+await session.store(user, "users/1");
+await session.saveChanges();
+
+// modify doc to create a new revision
+user.name = "Roman";
+user.age = 40;
+await session.saveChanges();
+
+// get revisions
+const revisions = await session.advanced.revisions.getFor("users/1");
+// [ { name: 'Roman',
+//     age: 40,
+//     pet: 'users/4',
+//     '@metadata': [Object],
+//     id: 'users/1' },
+//   { name: 'Marcin',
+//     age: 30,
+//     pet: 'users/4',
+//     '@metadata': [Object],
+//     id: 'users/1' } ]
+```
+
+
+
 ## Using object literals for entities
 
 In order to comfortably use object literals as entities set function getting collection name based on the content of the object - `store.conventions.

test/Documents/ReadmeSamples.ts

@@ -360,6 +360,10 @@ describe("Readme query samples", function () {
                 // ...
             });
 
+            userStream.on("end", () => {
+                assert.ok(result.length);
+            });
+
             await new Promise((resolve, reject) => {
                 stream.finished(userStream, err => {
                     err ? reject(err) : resolve();
@@ -369,12 +373,14 @@ describe("Readme query samples", function () {
 
         it("can stream query and get stats", async () => {
             let stats: StreamQueryStatistics;
+            const items = [];
             query = session.query({ collection: "users" })
                 .whereGreaterThan("age", 29);
             const queryStream = await session.advanced.stream(query, _ => stats = _);
 
             queryStream.on("data", user => {
                 print(user);
+                items.push(user);
                 // ...
             });
 
@@ -386,6 +392,7 @@ describe("Readme query samples", function () {
             await new Promise((resolve, reject) => {
                 queryStream.on("end", () => {
                     try {
+                        assert.ok(items.length);
                         assert.ok(stats);
                         assert.strictEqual(stats.totalResults, 1);
                         assert.strictEqual(stats.indexName, "Auto/users/Byage");
@@ -401,6 +408,33 @@ describe("Readme query samples", function () {
 
     });
 
+    describe("with revisions set up", function() {
+
+        beforeEach(async () => testContext.setupRevisions(store, false, 5));
+
+        it("can get revisions", async () => {
+
+            const session = store.openSession();
+
+            const user = {
+                name: "Marcin",
+                age: 30,
+                pet: "users/4"
+            };
+
+            await session.store(user, "users/1");
+            await session.saveChanges();
+
+            user.name = "Roman";
+            user.age = 40;
+            await session.saveChanges();
+
+            const revisions = await session.advanced.revisions.getFor("users/1");
+            assert.strictEqual(revisions.length, 2);
+        });
+
+    });
+
     async function prepareUserDataSet(store: IDocumentStore) {
         const users = [
             new User({