Skip to content
This repository was archived by the owner on Jun 22, 2021. It is now read-only.

Commit 56e7276

Browse files
committed
docs: Improves links.
1 parent ca0ecd1 commit 56e7276

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed

docs/filter.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Filter
22

3-
This is an object that filters the entities. The filter interface currently supports the following operators which have been borrowed from Mongo.
3+
This is an object that filters the entities. The [filter type definition](../src/types/Filter.ts) currently supports the following operators which have been borrowed from Mongo.
44

55
Operator | Description
66
--- | ---

docs/options.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,12 +36,12 @@ interface TodoEntity extends Id {
3636
This is an object containing some of the entity's properties. This package uses [TypeScript's Partial type](https://www.typescriptlang.org/docs/handbook/advanced-types.html) applied to an [Entity](#entity) (using `Partial<Entity>`).
3737

3838
### Filter
39-
This is an object that filters the entities. More information can be found in the [filter documentation](./filter.md).
39+
This is an object that filters the entities. More information can be found in the [filter documentation](./filter.md). This package contains the [TypeScript Filter type definition](../src/types/Filter.ts).
4040

4141
### Sort
4242
This is an object where a key represents the entity property to be sorted and the value represents the direction to sort. The value should be `true` to sort in ascending order and `false` to sort in descending order. The properties are sorted in order of their definition in the sort option, for example, the following sort option `{ createdAt: false, id: true }` will sort by the `createdAt` property first and then the the `id` property.
4343

44-
This package contains the [TypeScript Sort type definition](../src/types/Sort.ts)
44+
This package contains the [TypeScript Sort type definition](../src/types/Sort.ts).
4545

4646
### Pagination
4747
This is an object with three properties, `limit`, `forward`, and `cursor`. The `limit` property defines how many entities to return (maximum). The `forward` property defines whether the entities should be iterate through the entities forwards (when `true`) or backwards (when `false`) from the `cursor`. The `cursor` property defines where to start iterating through the entities.

0 commit comments

Comments
 (0)