Skip to content

Commit c878aa4

Browse files
authored
docs: update readme links (#81)
* Update * Update link * Fix links
1 parent 2f1a9da commit c878aa4

File tree

1 file changed

+7
-9
lines changed

1 file changed

+7
-9
lines changed

README.md

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,7 @@
33
</div>
44

55
<h1 align="center">
6-
<a href="https://kafkas.github.io/firewalk">
7-
firewalk
8-
</a>
6+
firewalk
97
</h1>
108

119
<p align="center">
@@ -57,7 +55,7 @@ Firewalk is designed to work with the [Firebase Admin SDK](https://github.com/fi
5755
npm install firebase-admin
5856
```
5957

60-
### Compatibility Map
58+
### Compatibility Table
6159

6260
Make sure to install the right version of Firewalk depending on the `firebase-admin` version your project is on.
6361

@@ -78,7 +76,7 @@ npm install firewalk
7876

7977
There are only 2 kinds of objects you need to be familiar with when using this library:
8078

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)).
8280

8381
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.
8482

@@ -198,9 +196,9 @@ console.log(`Updated ${migratedDocCount} posts!`);
198196

199197
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.
200198

201-
### [createTraverser](https://kafkas.github.io/firewalk/functions/createTraverser.html)
199+
### [createTraverser](https://kafkas.github.io/firewalk/v2/functions/createTraverser.html)
202200

203-
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).
204202

205203
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.
206204

@@ -220,7 +218,7 @@ where:
220218
- _D_: average document size
221219
- _S_: average extra space used by the callback
222220

223-
### [createMigrator](https://kafkas.github.io/firewalk/functions/createMigrator.html)
221+
### [createMigrator](https://kafkas.github.io/firewalk/v2/functions/createMigrator.html)
224222

225223
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.
226224

@@ -238,7 +236,7 @@ where:
238236
- _TC_(`traverser`): time complexity of the underlying traverser
239237
- _SC_(`traverser`): space complexity of the underlying traverser
240238

241-
### [createBatchMigrator](https://kafkas.github.io/firewalk/functions/createBatchMigrator.html)
239+
### [createBatchMigrator](https://kafkas.github.io/firewalk/v2/functions/createBatchMigrator.html)
242240

243241
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.
244242

0 commit comments

Comments
 (0)