Merge pull request #10 from llamadeus/documentation-fixes

Await watch call

Author: maradotwebp

packages/docs/src/pages/docs/changes.mdx

@@ -14,7 +14,7 @@ very fast, there is a better alternative.
 (The callback will also be called once with all items in the table right after you register your watcher).
 
 ```ts
-const dispose = watch(userTable, users => {
+const dispose = await watch(userTable, users => {
   console.log('All users', users);
 });
 ```
@@ -23,7 +23,7 @@ Only retrieving certain items from the table is also possible - just provide a [
 and your callback will only be called if items matching the filter are inserted/updated/deleted.
 
 ```ts
-const dispose = watch(userTable, { where: { age: { lt: 3 } } }, babies => {
+const dispose = await watch(userTable, { where: { age: { lt: 3 } } }, babies => {
   console.log('All babies: ', babies);
 });
 ```
@@ -32,4 +32,4 @@ If you want to stop receiving updates, call the function returned from [`watch()
 
 ```ts
 dispose();
-```
+```

packages/docs/src/pages/docs/index.mdx

@@ -97,14 +97,14 @@ resulting in incredible performance, regardless if you're working with **10.000*
     </div>
     ```ts
       // Either watch for changes on the whole table...
-      watch(userTable, users => {
+      await watch(userTable, users => {
         console.log('All users in the database:', users);
       });
 
       // ...or specify a filter
-      watch(userTable, { where: { age: { lt: 5 } } }, babies => {
+      await watch(userTable, { where: { age: { lt: 5 } } }, babies => {
         console.log('All babies in the database:', babies);
       });
     ```
   </div>
-</div>
+</div>

packages/docs/src/pages/docs/reference/watch.mdx

@@ -14,11 +14,11 @@ It's perfect for usage inside reactive components like React Hooks.
 
 ```ts
 // Call `callback` whenever ALL entities change
-watch(userTable, (users) => {
+await watch(userTable, (users) => {
   console.log("All users: ", users);
 });
 // Call `callback` whenever an item matching the filter changes
-watch(userTable, { where: { age: { lt: 3 } } }, (babies) => {
+await watch(userTable, { where: { age: { lt: 3 } } }, (babies) => {
   console.log("All babies: ", babies);
 });
 ```
@@ -34,10 +34,10 @@ watch(userTable, { where: { age: { lt: 3 } } }, (babies) => {
 If you want to stop watching for changes, call the function returned by `watch()`.
 
 ```ts
-const stop = watch(userTable, (users) => {
+const stop = await watch(userTable, (users) => {
   console.log("All users: ", users);
 });
 
 // Stop watching changes
 stop();
-```
+```