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

Commit 9dbf0a6

Browse files
authored
docs: Adds notes about utils.
1 parent 20f2f5f commit 9dbf0a6

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

docs/functions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ try {
4444
This package contains the [create entity tests](../src/tests/createEntity) and the [create entity signature](../src/signatures/CreateEntity.ts) for this function.
4545

4646
### getEntities
47-
Retreives a sorted paginated array of entities that match the [`filter`](./options.md#filter) option.
47+
Retreives a sorted paginated array of entities that match the [`filter`](./options.md#filter) option. Users of this function may want to use the [`createCursorFromEntity` utility function](./utils.md#createcursorfromentity) and may need to use the [`convertPropertyFilter` utility function](./utils.md#convertpropertyfilter). Implementors of this function will need to use the [`createCursorFromEntity`](./utils.md#createcursorfromentity) and [`createPaginationFilter`](./utils.md#createpaginationfilter) utility functions to generate and use cursors.
4848

4949
```ts
5050
import { backward, forward } from '@js-entity-repos/core/dist/types/PaginationDirection';

0 commit comments

Comments
 (0)