You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+7-9Lines changed: 7 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,9 +3,7 @@
3
3
</div>
4
4
5
5
<h1align="center">
6
-
<ahref="https://kafkas.github.io/firewalk">
7
-
firewalk
8
-
</a>
6
+
firewalk
9
7
</h1>
10
8
11
9
<palign="center">
@@ -57,7 +55,7 @@ Firewalk is designed to work with the [Firebase Admin SDK](https://github.com/fi
57
55
npm install firebase-admin
58
56
```
59
57
60
-
### Compatibility Map
58
+
### Compatibility Table
61
59
62
60
Make sure to install the right version of Firewalk depending on the `firebase-admin` version your project is on.
63
61
@@ -78,7 +76,7 @@ npm install firewalk
78
76
79
77
There are only 2 kinds of objects you need to be familiar with when using this library:
80
78
81
-
1.**Traverser**: An object that walks you through a collection of documents (or more generally a [Traversable](https://kafkas.github.io/firewalk/types/Traversable.html)).
79
+
1.**Traverser**: An object that walks you through a collection of documents (or more generally a [Traversable](https://kafkas.github.io/firewalk/v2/types/Traversable.html)).
82
80
83
81
2.**Migrator**: A convenience object used for database migrations. It lets you easily write to the documents within a given traversable and uses a traverser to do that. You can easily write your own migration logic in the traverser callback if you don't want to use a migrator.
You can find the full API reference for Firewalk [here](https://kafkas.github.io/firewalk). We maintain detailed docs for each major version. Here are some of the core functions that this library provides.
Creates an object which can be used to traverse a Firestore collection or, more generally, a [Traversable](https://kafkas.github.io/firewalk/types/Traversable.html).
201
+
Creates an object which can be used to traverse a Firestore collection or, more generally, a [Traversable](https://kafkas.github.io/firewalk/v2/types/Traversable.html).
204
202
205
203
For each batch of document snapshots in the traversable, the traverser invokes a specified async callback and immediately moves to the next batch. It does not wait for the callback Promise to resolve before moving to the next batch. That is, when `maxConcurrentBatchCount` > 1, there is no guarantee that any given batch will finish processing before a later batch.
Creates a migrator that facilitates database migrations. The migrator accepts a custom traverser to traverse the collection. Otherwise it will create a default traverser with your desired traversal config. This migrator does not use atomic batch writes so it is possible that when a write fails other writes go through.
226
224
@@ -238,7 +236,7 @@ where:
238
236
-_TC_(`traverser`): time complexity of the underlying traverser
239
237
-_SC_(`traverser`): space complexity of the underlying traverser
Creates a migrator that facilitates database migrations. The migrator accepts a custom traverser to traverse the collection. Otherwise it will create a default traverser with your desired traversal config. This migrator uses atomic batch writes so the entire operation will fail if a single write isn't successful.
0 commit comments