Skip to content

Commit 5898a56

Browse files
committed
docs: update batch-loader references
1 parent 128db6b commit 5898a56

File tree

2 files changed

+4
-6
lines changed

2 files changed

+4
-6
lines changed

docs/guides.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -64,8 +64,6 @@ module.exports = {
6464

6565
We often want to combine rows from two or more tables based on a relationship between them. The `fastJoin` hook will select records that have matching values in both tables. It can batch service calls and cache records, thereby needing roughly an order of magnitude fewer database calls than the `populate` hook, i.e. _2_ calls instead of _20_. It uses a [GraphQL](http://graphql.org/)-like imperative API.
6666

67-
`fastJoin` is not restricted to using data from Feathers services. Resources for which there are no Feathers adapters can [also be used](/v1/batch-loader/common-patterns.html#Using-non-Feathers-services).
68-
6967
### Usage
7068

7169
```js
@@ -260,7 +258,7 @@ const postResolvers = {
260258
};
261259
```
262260
263-
A resolver function can make any sort of modification to the passed record; it is not limited to making service calls. Resolvers can use resources for which there is [no Feathers adapter](/v1/batch-loader/common-patterns.html#Using-non-Feathers-services).
261+
A resolver function can make any sort of modification to the passed record; it is not limited to making service calls.
264262
265263
Here, the starerCount resolver adds the field `starerCount` containing a count of the `starIds`.
266264
@@ -421,7 +419,7 @@ We have been looking till now into the structure and flexibility of `fastJoin`.
421419
422420
We will use batch-loaders to dramatically reduce the number of database calls needed. Its not uncommon for operations that would have required _20_ database calls to make only _2_ using batch-loaders.
423421
424-
You need to understand batch-loaders before we proceed, so [read about them now.](../batch-loader/guide.html)
422+
You need to understand batch-loaders before we proceed, so [read about them now.](https://github.com/feathersjs-ecosystem/batch-loader)
425423
426424
### Using a Simple Batch-Loader
427425
@@ -524,7 +522,7 @@ const postResolvers = {
524522
}
525523
```
526524
527-
> The [batch-loader guide](../batch-loader) explains how to create batch-loaders.
525+
> The [batch-loader guide](https://github.com/feathersjs-ecosystem/batch-loader) explains how to create batch-loaders.
528526
529527
### Putting It All Together
530528

docs/hooks.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -891,7 +891,7 @@ The `cache` hook also makes `get` service calls more efficient.
891891
892892
Relationships such as `1:1`, `1:m`, `n:1`, and `n:m` relationships can be handled.
893893
894-
`fastJoin` uses a GraphQL-like imperative API, and it is not restricted to using data from Feathers services. Resources for which there are no Feathers adapters can [be used.](../batch-loader/common-patterns.html#Using-non-Feathers-services)
894+
`fastJoin` uses a GraphQL-like imperative API, and it is not restricted to using data from Feathers services. Resources for which there are no Feathers adapters can [be used.](https://github.com/feathersjs-ecosystem/batch-loader)
895895
896896
The companion `@feathers-plus/cache` implements a least recently-used cache which discards the least recently used items first. When used in conjunction with the `cache` hook, it can be used to implement persistent caches for BatchLoaders. BatchLoaders configured this way would retain their cache between requests, eliminating the need to _prime_ the cache at the start of each request.
897897

0 commit comments

Comments
 (0)